<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>modbus_tk.modbus</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/modbus-tk/">Modbus Test Kit</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="modbus_tk-module.html">Package&nbsp;modbus_tk</a> ::
        Module&nbsp;modbus
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="modbus_tk.modbus-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="modbus_tk.modbus-module.html">Module modbus_tk.modbus</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring"> Modbus TestKit: Implementation of Modbus protocol in python</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring"> (C)2009 - Luc Jean - luc.jean@gmail.com</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring"> (C)2009 - Apidev - http://www.apidev.fr</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring"> This is distributed under GNU LGPL license, see license.txt</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring"> History:</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring"> 2010/01/08 - RD: Update master.execute(..) to calculate lengths automatically based on requested command</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">__future__</tt> <tt class="py-keyword">import</tt> <tt class="py-name">with_statement</tt>  </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">struct</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module modbus_tk.defines=modbus_tk.defines-module.html"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-0', 'defines', 'link-0');">defines</a></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">threading</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Module modbus_tk.utils=modbus_tk.utils-module.html"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-1', 'utils', 'link-1');">utils</a></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-2', 'utils', 'link-1');">utils</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Function modbus_tk.utils.threadsafe_function()=modbus_tk.utils-module.html#threadsafe_function"><a title="modbus_tk.utils.threadsafe_function" class="py-name" href="#" onclick="return doclink('link-3', 'threadsafe_function', 'link-3');">threadsafe_function</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-4" class="py-name" targets="Module modbus_tk.hooks=modbus_tk.hooks-module.html"><a title="modbus_tk.hooks" class="py-name" href="#" onclick="return doclink('link-4', 'hooks', 'link-4');">hooks</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Function modbus_tk.hooks.call_hooks()=modbus_tk.hooks-module.html#call_hooks"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-5', 'call_hooks', 'link-5');">call_hooks</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-comment">#modbus_tk is using the python logging mechanism</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-comment">#you can define this logger in your app in order to see its prints logs</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt id="link-6" class="py-name" targets="Variable modbus_tk.modbus.LOGGER=modbus_tk.modbus-module.html#LOGGER,Variable modbus_tk.modbus_rtu.LOGGER=modbus_tk.modbus_rtu-module.html#LOGGER,Variable modbus_tk.modbus_tcp.LOGGER=modbus_tk.modbus_tcp-module.html#LOGGER,Variable modbus_tk.simulator.LOGGER=modbus_tk.simulator-module.html#LOGGER"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-6', 'LOGGER', 'link-6');">LOGGER</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tk"</tt><tt class="py-op">)</tt> </tt>
<a name="ModbusError"></a><div id="ModbusError-def"><a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-comment">#Exceptions</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <a class="py-toggle" href="#" id="ModbusError-toggle" onclick="return toggle('ModbusError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusError-class.html">ModbusError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusError-expanded"><a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line">    <tt class="py-docstring">"""Exception raised when the modbus slave returns an error"""</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">     </tt>
<a name="ModbusError.__init__"></a><div id="ModbusError.__init__-def"><a name="L35"></a><tt class="py-lineno"> 35</tt> <a class="py-toggle" href="#" id="ModbusError.__init__-toggle" onclick="return toggle('ModbusError.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusError-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">exception_code</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ModbusError.__init__-expanded"><a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">        <tt class="py-docstring">"""constructor: set the exception code returned by the slave"""</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">value</tt><tt class="py-op">:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line">            <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-string">"Modbus Error: Exception code = %d"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">exception_code</tt><tt class="py-op">)</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">        <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method modbus_tk.modbus.Databank.__init__()=modbus_tk.modbus.Databank-class.html#__init__,Method modbus_tk.modbus.Master.__init__()=modbus_tk.modbus.Master-class.html#__init__,Method modbus_tk.modbus.ModbusBlock.__init__()=modbus_tk.modbus.ModbusBlock-class.html#__init__,Method modbus_tk.modbus.ModbusError.__init__()=modbus_tk.modbus.ModbusError-class.html#__init__,Method modbus_tk.modbus.Query.__init__()=modbus_tk.modbus.Query-class.html#__init__,Method modbus_tk.modbus.Server.__init__()=modbus_tk.modbus.Server-class.html#__init__,Method modbus_tk.modbus.Slave.__init__()=modbus_tk.modbus.Slave-class.html#__init__,Method modbus_tk.modbus_rtu.RtuMaster.__init__()=modbus_tk.modbus_rtu.RtuMaster-class.html#__init__,Method modbus_tk.modbus_rtu.RtuQuery.__init__()=modbus_tk.modbus_rtu.RtuQuery-class.html#__init__,Method modbus_tk.modbus_rtu.RtuServer.__init__()=modbus_tk.modbus_rtu.RtuServer-class.html#__init__,Method modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__()=modbus_tk.modbus_tcp.ModbusInvalidMbapError-class.html#__init__,Method modbus_tk.modbus_tcp.TcpMaster.__init__()=modbus_tk.modbus_tcp.TcpMaster-class.html#__init__,Method modbus_tk.modbus_tcp.TcpMbap.__init__()=modbus_tk.modbus_tcp.TcpMbap-class.html#__init__,Method modbus_tk.modbus_tcp.TcpQuery.__init__()=modbus_tk.modbus_tcp.TcpQuery-class.html#__init__,Method modbus_tk.modbus_tcp.TcpServer.__init__()=modbus_tk.modbus_tcp.TcpServer-class.html#__init__,Method modbus_tk.simulator.CompositeServer.__init__()=modbus_tk.simulator.CompositeServer-class.html#__init__,Method modbus_tk.simulator.ConsoleInterface.__init__()=modbus_tk.simulator.ConsoleInterface-class.html#__init__,Method modbus_tk.simulator.RpcInterface.__init__()=modbus_tk.simulator.RpcInterface-class.html#__init__,Method modbus_tk.simulator.Simulator.__init__()=modbus_tk.simulator.Simulator-class.html#__init__,Method modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__()=modbus_tk.simulator_rpc_client.SimulatorRpcClient-class.html#__init__,Method modbus_tk.utils.ConsoleHandler.__init__()=modbus_tk.utils.ConsoleHandler-class.html#__init__,Method modbus_tk.utils.DummyHandler.__init__()=modbus_tk.utils.DummyHandler-class.html#__init__,Method modbus_tk.utils.LogitHandler.__init__()=modbus_tk.utils.LogitHandler-class.html#__init__,Method modbus_tk.utils.WorkerThread.__init__()=modbus_tk.utils.WorkerThread-class.html#__init__"><a title="modbus_tk.modbus.Databank.__init__
modbus_tk.modbus.Master.__init__
modbus_tk.modbus.ModbusBlock.__init__
modbus_tk.modbus.ModbusError.__init__
modbus_tk.modbus.Query.__init__
modbus_tk.modbus.Server.__init__
modbus_tk.modbus.Slave.__init__
modbus_tk.modbus_rtu.RtuMaster.__init__
modbus_tk.modbus_rtu.RtuQuery.__init__
modbus_tk.modbus_rtu.RtuServer.__init__
modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__
modbus_tk.modbus_tcp.TcpMaster.__init__
modbus_tk.modbus_tcp.TcpMbap.__init__
modbus_tk.modbus_tcp.TcpQuery.__init__
modbus_tk.modbus_tcp.TcpServer.__init__
modbus_tk.simulator.CompositeServer.__init__
modbus_tk.simulator.ConsoleInterface.__init__
modbus_tk.simulator.RpcInterface.__init__
modbus_tk.simulator.Simulator.__init__
modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__
modbus_tk.utils.ConsoleHandler.__init__
modbus_tk.utils.DummyHandler.__init__
modbus_tk.utils.LogitHandler.__init__
modbus_tk.utils.WorkerThread.__init__" class="py-name" href="#" onclick="return doclink('link-7', '__init__', 'link-7');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exception_code</tt> <tt class="py-op">=</tt> <tt class="py-name">exception_code</tt> </tt>
</div><a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">         </tt>
<a name="ModbusError.get_exception_code"></a><div id="ModbusError.get_exception_code-def"><a name="L42"></a><tt class="py-lineno"> 42</tt> <a class="py-toggle" href="#" id="ModbusError.get_exception_code-toggle" onclick="return toggle('ModbusError.get_exception_code');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusError-class.html#get_exception_code">get_exception_code</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusError.get_exception_code-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ModbusError.get_exception_code-expanded"><a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line">        <tt class="py-docstring">"""return the exception code returned by the slave (see defines)"""</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exception_code</tt> </tt>
</div></div><a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"> </tt>
<a name="ModbusFunctionNotSupportedError"></a><div id="ModbusFunctionNotSupportedError-def"><a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="ModbusFunctionNotSupportedError-toggle" onclick="return toggle('ModbusFunctionNotSupportedError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusFunctionNotSupportedError-class.html">ModbusFunctionNotSupportedError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusFunctionNotSupportedError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusFunctionNotSupportedError-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when calling a modbus function not supported by modbus_tk</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"> </tt>
<a name="DuplicatedKeyError"></a><div id="DuplicatedKeyError-def"><a name="L53"></a><tt class="py-lineno"> 53</tt> <a class="py-toggle" href="#" id="DuplicatedKeyError-toggle" onclick="return toggle('DuplicatedKeyError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.DuplicatedKeyError-class.html">DuplicatedKeyError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DuplicatedKeyError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DuplicatedKeyError-expanded"><a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when trying to add an object with a key that is already </tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">    used for another object</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"> </tt>
<a name="MissingKeyError"></a><div id="MissingKeyError-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="MissingKeyError-toggle" onclick="return toggle('MissingKeyError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.MissingKeyError-class.html">MissingKeyError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="MissingKeyError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="MissingKeyError-expanded"><a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when trying to get an object with a key that doesn't exist</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"> </tt>
<a name="InvalidModbusBlockError"></a><div id="InvalidModbusBlockError-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="InvalidModbusBlockError-toggle" onclick="return toggle('InvalidModbusBlockError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.InvalidModbusBlockError-class.html">InvalidModbusBlockError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InvalidModbusBlockError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidModbusBlockError-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">    <tt class="py-docstring">"""Exception raised when a modbus block is not valid"""</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"> </tt>
<a name="InvalidArgumentError"></a><div id="InvalidArgumentError-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="InvalidArgumentError-toggle" onclick="return toggle('InvalidArgumentError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.InvalidArgumentError-class.html">InvalidArgumentError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InvalidArgumentError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidArgumentError-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when one argument of a function doesn't meet </tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">    what is expected</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"> </tt>
<a name="OverlapModbusBlockError"></a><div id="OverlapModbusBlockError-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="OverlapModbusBlockError-toggle" onclick="return toggle('OverlapModbusBlockError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.OverlapModbusBlockError-class.html">OverlapModbusBlockError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="OverlapModbusBlockError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="OverlapModbusBlockError-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when adding modbus block on a memory address</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">    range already in use</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"> </tt>
<a name="OutOfModbusBlockError"></a><div id="OutOfModbusBlockError-def"><a name="L84"></a><tt class="py-lineno"> 84</tt> <a class="py-toggle" href="#" id="OutOfModbusBlockError-toggle" onclick="return toggle('OutOfModbusBlockError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.OutOfModbusBlockError-class.html">OutOfModbusBlockError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="OutOfModbusBlockError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="OutOfModbusBlockError-expanded"><a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line">    <tt class="py-docstring">"""Exception raised when accessing out of a modbus block"""</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"> </tt>
<a name="ModbusInvalidResponseError"></a><div id="ModbusInvalidResponseError-def"><a name="L88"></a><tt class="py-lineno"> 88</tt> <a class="py-toggle" href="#" id="ModbusInvalidResponseError-toggle" onclick="return toggle('ModbusInvalidResponseError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusInvalidResponseError-class.html">ModbusInvalidResponseError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusInvalidResponseError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusInvalidResponseError-expanded"><a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when the response sent by the slave doesn't fit </tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">    with the expected format</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"> </tt>
<a name="ModbusInvalidRequestError"></a><div id="ModbusInvalidRequestError-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="ModbusInvalidRequestError-toggle" onclick="return toggle('ModbusInvalidRequestError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusInvalidRequestError-class.html">ModbusInvalidRequestError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusInvalidRequestError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusInvalidRequestError-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when the request by the master doesn't fit </tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">    with the expected format</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"> </tt>
<a name="ModbusNotConnectedError"></a><div id="ModbusNotConnectedError-def"><a name="L102"></a><tt class="py-lineno">102</tt> <a class="py-toggle" href="#" id="ModbusNotConnectedError-toggle" onclick="return toggle('ModbusNotConnectedError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusNotConnectedError-class.html">ModbusNotConnectedError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusNotConnectedError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusNotConnectedError-expanded"><a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">    Exception raised when the master is not connected to the slave </tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">    <tt class="py-keyword">pass</tt> </tt>
</div><a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">         </tt>
<a name="Query"></a><div id="Query-def"><a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <a class="py-toggle" href="#" id="Query-toggle" onclick="return toggle('Query');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html">Query</a><tt class="py-op">:</tt> </tt>
</div><div id="Query-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Query-expanded"><a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">    Interface to be implemented in subclass for every specific modbus MAC layer</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">     </tt>
<a name="Query.__init__"></a><div id="Query.__init__-def"><a name="L114"></a><tt class="py-lineno">114</tt> <a class="py-toggle" href="#" id="Query.__init__-toggle" onclick="return toggle('Query.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>  </tt>
</div><a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor"""</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line">     </tt>
<a name="Query.build_request"></a><div id="Query.build_request-def"><a name="L118"></a><tt class="py-lineno">118</tt> <a class="py-toggle" href="#" id="Query.build_request-toggle" onclick="return toggle('Query.build_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html#build_request">build_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pdu</tt><tt class="py-op">,</tt> <tt class="py-param">slave</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.build_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Query.build_request-expanded"><a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">        Get the modbus application protocol request pdu and slave id</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">        Encapsulate with MAC layer information</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">        Returns a string</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line">     </tt>
<a name="Query.parse_response"></a><div id="Query.parse_response-def"><a name="L126"></a><tt class="py-lineno">126</tt> <a class="py-toggle" href="#" id="Query.parse_response-toggle" onclick="return toggle('Query.parse_response');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html#parse_response">parse_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">response</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.parse_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Query.parse_response-expanded"><a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring">        Get the full response and extract the modbus application protocol</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">        response pdu</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">        Returns a string</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">     </tt>
<a name="Query.parse_request"></a><div id="Query.parse_request-def"><a name="L134"></a><tt class="py-lineno">134</tt> <a class="py-toggle" href="#" id="Query.parse_request-toggle" onclick="return toggle('Query.parse_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html#parse_request">parse_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.parse_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Query.parse_request-expanded"><a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring">        Get the full request and extract the modbus application protocol </tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">        request pdu</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">        Returns a string and the slave id</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">     </tt>
<a name="Query.build_response"></a><div id="Query.build_response-def"><a name="L142"></a><tt class="py-lineno">142</tt> <a class="py-toggle" href="#" id="Query.build_response-toggle" onclick="return toggle('Query.build_response');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Query-class.html#build_response">build_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">response_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.build_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Query.build_response-expanded"><a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">        Get the modbus application protocol response pdu and encapsulate with</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">        MAC layer information</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">        Returns a string</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"> </tt>
<a name="Master"></a><div id="Master-def"><a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <a class="py-toggle" href="#" id="Master-toggle" onclick="return toggle('Master');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html">Master</a><tt class="py-op">:</tt> </tt>
</div><div id="Master-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Master-expanded"><a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">    This class implements the Modbus Application protocol for a master</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"><tt class="py-docstring">    To be subclassed with a class implementing the MAC layer</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"> </tt>
<a name="Master.__init__"></a><div id="Master.__init__-def"><a name="L157"></a><tt class="py-lineno">157</tt> <a class="py-toggle" href="#" id="Master.__init__-toggle" onclick="return toggle('Master.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout_in_sec</tt><tt class="py-op">,</tt> <tt class="py-param">hooks</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.__init__-expanded"><a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor: can define a timeout"""</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout</tt> <tt class="py-op">=</tt> <tt class="py-name">timeout_in_sec</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_is_opened</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">         </tt>
<a name="Master.__del__"></a><div id="Master.__del__-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="Master.__del__-toggle" onclick="return toggle('Master.__del__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#__del__">__del__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.__del__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.__del__-expanded"><a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt class="py-docstring">"""Destructor: close the connection"""</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method modbus_tk.modbus.Master.close()=modbus_tk.modbus.Master-class.html#close,Method modbus_tk.modbus_rtu.RtuServer.close()=modbus_tk.modbus_rtu.RtuServer-class.html#close,Method modbus_tk.simulator.ConsoleInterface.close()=modbus_tk.simulator.ConsoleInterface-class.html#close,Method modbus_tk.simulator.RpcInterface.close()=modbus_tk.simulator.RpcInterface-class.html#close,Method modbus_tk.simulator.Simulator.close()=modbus_tk.simulator.Simulator-class.html#close"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-8', 'close', 'link-8');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">                    </tt>
<a name="Master.set_verbose"></a><div id="Master.set_verbose-def"><a name="L167"></a><tt class="py-lineno">167</tt> <a class="py-toggle" href="#" id="Master.set_verbose-toggle" onclick="return toggle('Master.set_verbose');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#set_verbose">set_verbose</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">verbose</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.set_verbose-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.set_verbose-expanded"><a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">        <tt class="py-docstring">"""print some more log prints for debug purpose"""</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt> <tt class="py-op">=</tt> <tt class="py-name">verbose</tt> </tt>
</div><a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">     </tt>
<a name="Master.open"></a><div id="Master.open-def"><a name="L171"></a><tt class="py-lineno">171</tt> <a class="py-toggle" href="#" id="Master.open-toggle" onclick="return toggle('Master.open');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#open">open</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.open-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.open-expanded"><a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">        <tt class="py-docstring">"""open the communication with the slave"""</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_is_opened</tt><tt class="py-op">:</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method modbus_tk.modbus.Master._do_open()=modbus_tk.modbus.Master-class.html#_do_open,Method modbus_tk.modbus_rtu.RtuMaster._do_open()=modbus_tk.modbus_rtu.RtuMaster-class.html#_do_open,Method modbus_tk.modbus_tcp.TcpMaster._do_open()=modbus_tk.modbus_tcp.TcpMaster-class.html#_do_open"><a title="modbus_tk.modbus.Master._do_open
modbus_tk.modbus_rtu.RtuMaster._do_open
modbus_tk.modbus_tcp.TcpMaster._do_open" class="py-name" href="#" onclick="return doclink('link-9', '_do_open', 'link-9');">_do_open</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_is_opened</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"> </tt>
<a name="Master.close"></a><div id="Master.close-def"><a name="L177"></a><tt class="py-lineno">177</tt> <a class="py-toggle" href="#" id="Master.close-toggle" onclick="return toggle('Master.close');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.close-expanded"><a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line">        <tt class="py-docstring">"""close the communication with the slave"""</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_is_opened</tt><tt class="py-op">:</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method modbus_tk.modbus.Master._do_close()=modbus_tk.modbus.Master-class.html#_do_close,Method modbus_tk.modbus_rtu.RtuMaster._do_close()=modbus_tk.modbus_rtu.RtuMaster-class.html#_do_close,Method modbus_tk.modbus_tcp.TcpMaster._do_close()=modbus_tk.modbus_tcp.TcpMaster-class.html#_do_close"><a title="modbus_tk.modbus.Master._do_close
modbus_tk.modbus_rtu.RtuMaster._do_close
modbus_tk.modbus_tcp.TcpMaster._do_close" class="py-name" href="#" onclick="return doclink('link-10', '_do_close', 'link-10');">_do_close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_is_opened</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line">         </tt>
<a name="Master._do_open"></a><div id="Master._do_open-def"><a name="L183"></a><tt class="py-lineno">183</tt> <a class="py-toggle" href="#" id="Master._do_open-toggle" onclick="return toggle('Master._do_open');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#_do_open">_do_open</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master._do_open-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master._do_open-expanded"><a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line">        <tt class="py-docstring">"""Open the MAC layer"""</tt>     </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">     </tt>
<a name="Master._do_close"></a><div id="Master._do_close-def"><a name="L187"></a><tt class="py-lineno">187</tt> <a class="py-toggle" href="#" id="Master._do_close-toggle" onclick="return toggle('Master._do_close');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#_do_close">_do_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master._do_close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master._do_close-expanded"><a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">        <tt class="py-docstring">"""Close the MAC layer"""</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">     </tt>
<a name="Master._send"></a><div id="Master._send-def"><a name="L191"></a><tt class="py-lineno">191</tt> <a class="py-toggle" href="#" id="Master._send-toggle" onclick="return toggle('Master._send');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#_send">_send</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">buf</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master._send-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master._send-expanded"><a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line">        <tt class="py-docstring">"""Send data to a slave on the MAC layer"""</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line">     </tt>
<a name="Master._recv"></a><div id="Master._recv-def"><a name="L195"></a><tt class="py-lineno">195</tt> <a class="py-toggle" href="#" id="Master._recv-toggle" onclick="return toggle('Master._recv');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#_recv">_recv</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">expected_length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master._recv-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master._recv-expanded"><a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"><tt class="py-docstring">        Receive data from a slave on the MAC layer</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">        if expected_length is &gt;=0 then consider that the response is done when this</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">        number of bytes is received</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line">     </tt>
<a name="Master._make_query"></a><div id="Master._make_query-def"><a name="L203"></a><tt class="py-lineno">203</tt> <a class="py-toggle" href="#" id="Master._make_query-toggle" onclick="return toggle('Master._make_query');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#_make_query">_make_query</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master._make_query-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master._make_query-expanded"><a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">        Returns an instance of a Query subclass implementing </tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">        the MAC layer protocol</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line">     </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line">    <tt class="py-decorator">@</tt><tt class="py-decorator">threadsafe_function</tt> </tt>
<a name="Master.execute"></a><div id="Master.execute-def"><a name="L211"></a><tt class="py-lineno">211</tt> <a class="py-toggle" href="#" id="Master.execute-toggle" onclick="return toggle('Master.execute');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#execute">execute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave</tt><tt class="py-op">,</tt> <tt class="py-param">function_code</tt><tt class="py-op">,</tt> <tt class="py-param">starting_address</tt><tt class="py-op">,</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">                <tt class="py-param">quantity_of_x</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">output_value</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">data_format</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">,</tt> <tt class="py-param">expected_length</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.execute-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.execute-expanded"><a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"><tt class="py-docstring">        Execute a modbus query and returns the data part of the answer as a tuple</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line"><tt class="py-docstring">        The returned tuple depends on the query function code. see modbus protocol</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line"><tt class="py-docstring">        specification for details</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"><tt class="py-docstring">        data_format makes possible to extract the data like defined in the</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-docstring">        struct python module documentation</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">        <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line">        <tt class="py-name">is_read_function</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">        <tt class="py-name">nb_of_digits</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line">        <tt class="py-comment">#open the connection if it is not already done</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method modbus_tk.modbus.Master.open()=modbus_tk.modbus.Master-class.html#open"><a title="modbus_tk.modbus.Master.open" class="py-name" href="#" onclick="return doclink('link-11', 'open', 'link-11');">open</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line">        <tt class="py-comment">#Build the modbus pdu and the format of the expected data.</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">        <tt class="py-comment">#It depends of function code. see modbus specifications for details.</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-12" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-12', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Variable modbus_tk.defines.READ_COILS=modbus_tk.defines-module.html#READ_COILS"><a title="modbus_tk.defines.READ_COILS" class="py-name" href="#" onclick="return doclink('link-13', 'READ_COILS', 'link-13');">READ_COILS</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-14" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-14', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Variable modbus_tk.defines.READ_DISCRETE_INPUTS=modbus_tk.defines-module.html#READ_DISCRETE_INPUTS"><a title="modbus_tk.defines.READ_DISCRETE_INPUTS" class="py-name" href="#" onclick="return doclink('link-15', 'READ_DISCRETE_INPUTS', 'link-15');">READ_DISCRETE_INPUTS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">            <tt class="py-name">is_read_function</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line">            <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.pack()=modbus_tk.modbus_tcp.TcpMbap-class.html#pack"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-16', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BHH"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line">            <tt class="py-name">byte_count</tt> <tt class="py-op">=</tt> <tt class="py-name">quantity_of_x</tt> <tt class="py-op">/</tt> <tt class="py-number">8</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">%</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line">                <tt class="py-name">byte_count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">            <tt class="py-name">nb_of_digits</tt> <tt class="py-op">=</tt> <tt class="py-name">quantity_of_x</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">data_format</tt><tt class="py-op">:</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">                <tt class="py-name">data_format</tt> <tt class="py-op">=</tt> <tt class="py-string">"&gt;"</tt><tt class="py-op">+</tt><tt class="py-op">(</tt><tt class="py-name">byte_count</tt><tt class="py-op">*</tt><tt class="py-string">"B"</tt><tt class="py-op">)</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">expected_length</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt>  <tt class="py-comment">#No lenght was specified and calculated length can be used:</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">                <tt class="py-name">expected_length</tt> <tt class="py-op">=</tt> <tt class="py-name">byte_count</tt> <tt class="py-op">+</tt> <tt class="py-number">5</tt>  <tt class="py-comment">#slave + func + bytcodeLen + bytecode + crc1 + crc2</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-17" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-17', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Variable modbus_tk.defines.READ_INPUT_REGISTERS=modbus_tk.defines-module.html#READ_INPUT_REGISTERS"><a title="modbus_tk.defines.READ_INPUT_REGISTERS" class="py-name" href="#" onclick="return doclink('link-18', 'READ_INPUT_REGISTERS', 'link-18');">READ_INPUT_REGISTERS</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-19" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-19', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Variable modbus_tk.defines.READ_HOLDING_REGISTERS=modbus_tk.defines-module.html#READ_HOLDING_REGISTERS"><a title="modbus_tk.defines.READ_HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-20', 'READ_HOLDING_REGISTERS', 'link-20');">READ_HOLDING_REGISTERS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">            <tt class="py-name">is_read_function</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">            <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-21', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BHH"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">data_format</tt><tt class="py-op">:</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line">                <tt class="py-name">data_format</tt> <tt class="py-op">=</tt> <tt class="py-string">"&gt;"</tt><tt class="py-op">+</tt><tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt><tt class="py-op">*</tt><tt class="py-string">"H"</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">expected_length</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt>  <tt class="py-comment">#No lenght was specified and calculated length can be used:</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line">                <tt class="py-name">expected_length</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt><tt class="py-op">*</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">+</tt> <tt class="py-number">5</tt>  <tt class="py-comment">#slave + func + bytcodeLen + bytecode x 2 + crc1 + crc2</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-22" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-22', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Variable modbus_tk.defines.WRITE_SINGLE_COIL=modbus_tk.defines-module.html#WRITE_SINGLE_COIL"><a title="modbus_tk.defines.WRITE_SINGLE_COIL" class="py-name" href="#" onclick="return doclink('link-23', 'WRITE_SINGLE_COIL', 'link-23');">WRITE_SINGLE_COIL</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-24" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-24', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Variable modbus_tk.defines.WRITE_SINGLE_REGISTER=modbus_tk.defines-module.html#WRITE_SINGLE_REGISTER"><a title="modbus_tk.defines.WRITE_SINGLE_REGISTER" class="py-name" href="#" onclick="return doclink('link-25', 'WRITE_SINGLE_REGISTER', 'link-25');">WRITE_SINGLE_REGISTER</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-26" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-26', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="modbus_tk.defines.WRITE_SINGLE_COIL" class="py-name" href="#" onclick="return doclink('link-27', 'WRITE_SINGLE_COIL', 'link-23');">WRITE_SINGLE_COIL</a></tt><tt class="py-op">:</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">output_value</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line">                    <tt class="py-name">output_value</tt> <tt class="py-op">=</tt> <tt class="py-number">0xff00</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line">            <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-28', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BHH"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">output_value</tt><tt class="py-op">)</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">data_format</tt><tt class="py-op">:</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line">                <tt class="py-name">data_format</tt> <tt class="py-op">=</tt> <tt class="py-string">"&gt;HH"</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">expected_length</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt>  <tt class="py-comment">#No lenght was specified and calculated length can be used:</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line">                <tt class="py-name">expected_length</tt> <tt class="py-op">=</tt> <tt class="py-number">8</tt>  <tt class="py-comment">#slave + func + adress1 + adress2 + value1+value2 + crc1 + crc2</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-29" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-29', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Variable modbus_tk.defines.WRITE_MULTIPLE_COILS=modbus_tk.defines-module.html#WRITE_MULTIPLE_COILS"><a title="modbus_tk.defines.WRITE_MULTIPLE_COILS" class="py-name" href="#" onclick="return doclink('link-30', 'WRITE_MULTIPLE_COILS', 'link-30');">WRITE_MULTIPLE_COILS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line">            <tt class="py-name">byte_count</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">output_value</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-number">8</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">output_value</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line">                <tt class="py-name">byte_count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line">            <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-31', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BHHB"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">output_value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">byte_count</tt><tt class="py-op">)</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line">            <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">j</tt> <tt class="py-keyword">in</tt> <tt class="py-name">output_value</tt><tt class="py-op">:</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">j</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line">                    <tt class="py-name">byte_value</tt> <tt class="py-op">+=</tt> <tt class="py-name">pow</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">)</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">==</tt> <tt class="py-number">7</tt><tt class="py-op">:</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">                    <tt class="py-name">pdu</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-32', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt><tt class="py-op">)</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line">                    <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">                    <tt class="py-name">i</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">                <tt class="py-name">pdu</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-33', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt><tt class="py-op">)</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">data_format</tt><tt class="py-op">:</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line">                <tt class="py-name">data_format</tt> <tt class="py-op">=</tt> <tt class="py-string">"&gt;HH"</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">expected_length</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt>  <tt class="py-comment">#No lenght was specified and calculated length can be used:</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">                <tt class="py-name">expected_length</tt> <tt class="py-op">=</tt> <tt class="py-number">8</tt>  <tt class="py-comment">#slave + func + adress1 + adress2 + outputQuant1 + outputQuant2 + crc1 + crc2</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">function_code</tt> <tt class="py-op">==</tt> <tt id="link-34" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-34', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Variable modbus_tk.defines.WRITE_MULTIPLE_REGISTERS=modbus_tk.defines-module.html#WRITE_MULTIPLE_REGISTERS"><a title="modbus_tk.defines.WRITE_MULTIPLE_REGISTERS" class="py-name" href="#" onclick="return doclink('link-35', 'WRITE_MULTIPLE_REGISTERS', 'link-35');">WRITE_MULTIPLE_REGISTERS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line">            <tt class="py-name">byte_count</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> <tt class="py-op">*</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">output_value</tt><tt class="py-op">)</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">            <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-36', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BHHB"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">output_value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">byte_count</tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">j</tt> <tt class="py-keyword">in</tt> <tt class="py-name">output_value</tt><tt class="py-op">:</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">                <tt class="py-name">pdu</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-37', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;H"</tt><tt class="py-op">,</tt> <tt class="py-name">j</tt><tt class="py-op">)</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">data_format</tt><tt class="py-op">:</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">                <tt class="py-name">data_format</tt> <tt class="py-op">=</tt> <tt class="py-string">"&gt;HH"</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">expected_length</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt>  <tt class="py-comment">#No lenght was specified and calculated length can be used:</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">                <tt class="py-name">expected_length</tt> <tt class="py-op">=</tt> <tt class="py-number">8</tt>  <tt class="py-comment">#slave + func + adress1 + adress2 + outputQuant1 + outputQuant2 + crc1 + crc2</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line"> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-38" class="py-name" targets="Class modbus_tk.modbus.ModbusFunctionNotSupportedError=modbus_tk.modbus.ModbusFunctionNotSupportedError-class.html"><a title="modbus_tk.modbus.ModbusFunctionNotSupportedError" class="py-name" href="#" onclick="return doclink('link-38', 'ModbusFunctionNotSupportedError', 'link-38');">ModbusFunctionNotSupportedError</a></tt><tt class="py-op">(</tt><tt class="py-string">"The %d function code is not supported. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">function_code</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line"> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">        <tt class="py-comment"># instantiate a query which implements the MAC (TCP or RTU) part of the protocol</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line">        <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Method modbus_tk.modbus.Master._make_query()=modbus_tk.modbus.Master-class.html#_make_query,Method modbus_tk.modbus.Server._make_query()=modbus_tk.modbus.Server-class.html#_make_query,Method modbus_tk.modbus_rtu.RtuMaster._make_query()=modbus_tk.modbus_rtu.RtuMaster-class.html#_make_query,Method modbus_tk.modbus_rtu.RtuServer._make_query()=modbus_tk.modbus_rtu.RtuServer-class.html#_make_query,Method modbus_tk.modbus_tcp.TcpMaster._make_query()=modbus_tk.modbus_tcp.TcpMaster-class.html#_make_query,Method modbus_tk.modbus_tcp.TcpServer._make_query()=modbus_tk.modbus_tcp.TcpServer-class.html#_make_query,Method modbus_tk.simulator.CompositeServer._make_query()=modbus_tk.simulator.CompositeServer-class.html#_make_query"><a title="modbus_tk.modbus.Master._make_query
modbus_tk.modbus.Server._make_query
modbus_tk.modbus_rtu.RtuMaster._make_query
modbus_tk.modbus_rtu.RtuServer._make_query
modbus_tk.modbus_tcp.TcpMaster._make_query
modbus_tk.modbus_tcp.TcpServer._make_query
modbus_tk.simulator.CompositeServer._make_query" class="py-name" href="#" onclick="return doclink('link-39', '_make_query', 'link-39');">_make_query</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line">        <tt class="py-comment"># add the mac part of the protocol to the request</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">        <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method modbus_tk.modbus.Query.build_request()=modbus_tk.modbus.Query-class.html#build_request,Method modbus_tk.modbus_rtu.RtuQuery.build_request()=modbus_tk.modbus_rtu.RtuQuery-class.html#build_request,Method modbus_tk.modbus_tcp.TcpQuery.build_request()=modbus_tk.modbus_tcp.TcpQuery-class.html#build_request"><a title="modbus_tk.modbus.Query.build_request
modbus_tk.modbus_rtu.RtuQuery.build_request
modbus_tk.modbus_tcp.TcpQuery.build_request" class="py-name" href="#" onclick="return doclink('link-40', 'build_request', 'link-40');">build_request</a></tt><tt class="py-op">(</tt><tt class="py-name">pdu</tt><tt class="py-op">,</tt> <tt class="py-name">slave</tt><tt class="py-op">)</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line">        <tt class="py-comment"># send the request to the slave</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line">        <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-41" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-41', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Master.before_send"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line">            <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line">            <tt id="link-42" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-42', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt id="link-43" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-43', 'utils', 'link-1');">utils</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name" targets="Function modbus_tk.utils.get_log_buffer()=modbus_tk.utils-module.html#get_log_buffer"><a title="modbus_tk.utils.get_log_buffer" class="py-name" href="#" onclick="return doclink('link-44', 'get_log_buffer', 'link-44');">get_log_buffer</a></tt><tt class="py-op">(</tt><tt class="py-string">"-&gt; "</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Method modbus_tk.modbus.Master._send()=modbus_tk.modbus.Master-class.html#_send,Method modbus_tk.modbus_rtu.RtuMaster._send()=modbus_tk.modbus_rtu.RtuMaster-class.html#_send,Method modbus_tk.modbus_tcp.TcpMaster._send()=modbus_tk.modbus_tcp.TcpMaster-class.html#_send"><a title="modbus_tk.modbus.Master._send
modbus_tk.modbus_rtu.RtuMaster._send
modbus_tk.modbus_tcp.TcpMaster._send" class="py-name" href="#" onclick="return doclink('link-45', '_send', 'link-45');">_send</a></tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">        <tt id="link-46" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-46', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Master.after_send"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">slave</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">            <tt class="py-comment"># receive the data from the slave</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line">            <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name" targets="Method modbus_tk.modbus.Master._recv()=modbus_tk.modbus.Master-class.html#_recv,Method modbus_tk.modbus_rtu.RtuMaster._recv()=modbus_tk.modbus_rtu.RtuMaster-class.html#_recv,Method modbus_tk.modbus_tcp.TcpMaster._recv()=modbus_tk.modbus_tcp.TcpMaster-class.html#_recv"><a title="modbus_tk.modbus.Master._recv
modbus_tk.modbus_rtu.RtuMaster._recv
modbus_tk.modbus_tcp.TcpMaster._recv" class="py-name" href="#" onclick="return doclink('link-47', '_recv', 'link-47');">_recv</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_length</tt><tt class="py-op">)</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">            <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-48', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Master.after_recv"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line">                <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line">                <tt id="link-49" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-49', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt id="link-50" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-50', 'utils', 'link-1');">utils</a></tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="modbus_tk.utils.get_log_buffer" class="py-name" href="#" onclick="return doclink('link-51', 'get_log_buffer', 'link-44');">get_log_buffer</a></tt><tt class="py-op">(</tt><tt class="py-string">"&lt;- "</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line">            <tt class="py-comment"># extract the pdu part of the response</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line">            <tt class="py-name">response_pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method modbus_tk.modbus.Query.parse_response()=modbus_tk.modbus.Query-class.html#parse_response,Method modbus_tk.modbus_rtu.RtuQuery.parse_response()=modbus_tk.modbus_rtu.RtuQuery-class.html#parse_response,Method modbus_tk.modbus_tcp.TcpQuery.parse_response()=modbus_tk.modbus_tcp.TcpQuery-class.html#parse_response"><a title="modbus_tk.modbus.Query.parse_response
modbus_tk.modbus_rtu.RtuQuery.parse_response
modbus_tk.modbus_tcp.TcpQuery.parse_response" class="py-name" href="#" onclick="return doclink('link-52', 'parse_response', 'link-52');">parse_response</a></tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line">            <tt class="py-comment"># analyze the received data</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">return_code</tt><tt class="py-op">,</tt> <tt class="py-name">byte_2</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.unpack()=modbus_tk.modbus_tcp.TcpMbap-class.html#unpack"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-53', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BB"</tt><tt class="py-op">,</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">:</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">return_code</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0x80</tt><tt class="py-op">:</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line">                <tt class="py-comment"># the slave has returned an error</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line">                <tt class="py-name">exception_code</tt> <tt class="py-op">=</tt> <tt class="py-name">byte_2</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-54" class="py-name" targets="Class modbus_tk.modbus.ModbusError=modbus_tk.modbus.ModbusError-class.html"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-54', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt class="py-name">exception_code</tt><tt class="py-op">)</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">is_read_function</tt><tt class="py-op">:</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">                    <tt class="py-comment"># get the values returned by the reading function</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line">                    <tt class="py-name">byte_count</tt> <tt class="py-op">=</tt> <tt class="py-name">byte_2</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">                    <tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">byte_count</tt> <tt class="py-op">!=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">                        <tt class="py-comment"># the byte count in the pdu is invalid</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">                        <tt class="py-keyword">raise</tt> <tt id="link-55" class="py-name" targets="Class modbus_tk.modbus.ModbusInvalidResponseError=modbus_tk.modbus.ModbusInvalidResponseError-class.html"><a title="modbus_tk.modbus.ModbusInvalidResponseError" class="py-name" href="#" onclick="return doclink('link-55', 'ModbusInvalidResponseError', 'link-55');">ModbusInvalidResponseError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Byte count is %d while actual number of bytes is %d. "</tt> \ </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">                            <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">byte_count</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line">                    <tt class="py-comment"># returns what is returned by the slave after a writing function</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line">                    <tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line">                <tt class="py-comment">#returns the data as a tuple according to the data_format</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">                <tt class="py-comment">#(calculated based on the function or user-defined)</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line">                <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-56', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">data_format</tt><tt class="py-op">,</tt> <tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">nb_of_digits</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line">                    <tt class="py-name">digits</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line">                    <tt class="py-keyword">for</tt> <tt class="py-name">byte_val</tt> <tt class="py-keyword">in</tt> <tt class="py-name">result</tt><tt class="py-op">:</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line">                        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-number">8</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line">                            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">digits</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">nb_of_digits</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line">                                <tt class="py-keyword">break</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line">                            <tt class="py-name">digits</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">byte_val</tt> <tt class="py-op">%</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line">                            <tt class="py-name">byte_val</tt> <tt class="py-op">=</tt> <tt class="py-name">byte_val</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-number">1</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line">                    <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">digits</tt><tt class="py-op">)</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"> </tt>
<a name="Master.set_timeout"></a><div id="Master.set_timeout-def"><a name="L356"></a><tt class="py-lineno">356</tt> <a class="py-toggle" href="#" id="Master.set_timeout-toggle" onclick="return toggle('Master.set_timeout');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#set_timeout">set_timeout</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout_in_sec</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.set_timeout-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.set_timeout-expanded"><a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line">        <tt class="py-docstring">"""Defines a timeout on the MAC layer"""</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout</tt> <tt class="py-op">=</tt> <tt class="py-name">timeout_in_sec</tt> </tt>
</div><a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line"> </tt>
<a name="Master.get_timeout"></a><div id="Master.get_timeout-def"><a name="L360"></a><tt class="py-lineno">360</tt> <a class="py-toggle" href="#" id="Master.get_timeout-toggle" onclick="return toggle('Master.get_timeout');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Master-class.html#get_timeout">get_timeout</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Master.get_timeout-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Master.get_timeout-expanded"><a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line">        <tt class="py-docstring">"""Gets the current value of the MAC layer timeout"""</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout</tt> </tt>
</div></div><a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"> </tt>
<a name="ModbusBlock"></a><div id="ModbusBlock-def"><a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt> <a class="py-toggle" href="#" id="ModbusBlock-toggle" onclick="return toggle('ModbusBlock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusBlock-class.html">ModbusBlock</a><tt class="py-op">:</tt> </tt>
</div><div id="ModbusBlock-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusBlock-expanded"><a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">    <tt class="py-docstring">"""This class represents the values for a range of addresses"""</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line">     </tt>
<a name="ModbusBlock.__init__"></a><div id="ModbusBlock.__init__-def"><a name="L368"></a><tt class="py-lineno">368</tt> <a class="py-toggle" href="#" id="ModbusBlock.__init__-toggle" onclick="return toggle('ModbusBlock.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusBlock-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">starting_address</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusBlock.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ModbusBlock.__init__-expanded"><a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line"><tt class="py-docstring">        Contructor: defines the address range and creates the array of values</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> <tt class="py-op">=</tt> <tt class="py-name">starting_address</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">*</tt><tt class="py-name">size</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
</div><a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line">         </tt>
<a name="ModbusBlock.is_in"></a><div id="ModbusBlock.is_in-def"><a name="L376"></a><tt class="py-lineno">376</tt> <a class="py-toggle" href="#" id="ModbusBlock.is_in-toggle" onclick="return toggle('ModbusBlock.is_in');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.ModbusBlock-class.html#is_in">is_in</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">starting_address</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusBlock.is_in-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ModbusBlock.is_in-expanded"><a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-docstring">        Returns true if a block with the given address and size</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-docstring">        would overlap this block</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">starting_address</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">&gt;</tt><tt class="py-name">starting_address</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">starting_address</tt> <tt class="py-op">&lt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt><tt class="py-op">:</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">+</tt><tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">&gt;</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div></div><a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line">     </tt>
<a name="Slave"></a><div id="Slave-def"><a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <a class="py-toggle" href="#" id="Slave-toggle" onclick="return toggle('Slave');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html">Slave</a><tt class="py-op">:</tt> </tt>
</div><div id="Slave-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Slave-expanded"><a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line"><tt class="py-docstring">    This class define a modbus slave which is in charge of making the action</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line"><tt class="py-docstring">    asked by a modbus query</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line">     </tt>
<a name="Slave.__init__"></a><div id="Slave.__init__-def"><a name="L394"></a><tt class="py-lineno">394</tt> <a class="py-toggle" href="#" id="Slave.__init__-toggle" onclick="return toggle('Slave.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.__init__-expanded"><a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor"""</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_id</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> <tt class="py-comment"># the map registring all blocks of the slave</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt>  <tt class="py-line">        <tt class="py-comment"># a shortcut to find blocks per type</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-number">3</tt><tt class="py-op">:</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-number">4</tt><tt class="py-op">:</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">}</tt>  </tt>
<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line">        <tt class="py-comment"># a lock for mutual access to the _blocks and _memory maps</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt>  </tt>
<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line">        <tt class="py-comment">#map modbus function code to a function:</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fn_code_map</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt id="link-57" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-57', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="modbus_tk.defines.READ_COILS" class="py-name" href="#" onclick="return doclink('link-58', 'READ_COILS', 'link-13');">READ_COILS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name" targets="Method modbus_tk.modbus.Slave._read_coils()=modbus_tk.modbus.Slave-class.html#_read_coils"><a title="modbus_tk.modbus.Slave._read_coils" class="py-name" href="#" onclick="return doclink('link-59', '_read_coils', 'link-59');">_read_coils</a></tt><tt class="py-op">,</tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line">                             <tt id="link-60" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-60', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="modbus_tk.defines.READ_DISCRETE_INPUTS" class="py-name" href="#" onclick="return doclink('link-61', 'READ_DISCRETE_INPUTS', 'link-15');">READ_DISCRETE_INPUTS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name" targets="Method modbus_tk.modbus.Slave._read_discrete_inputs()=modbus_tk.modbus.Slave-class.html#_read_discrete_inputs"><a title="modbus_tk.modbus.Slave._read_discrete_inputs" class="py-name" href="#" onclick="return doclink('link-62', '_read_discrete_inputs', 'link-62');">_read_discrete_inputs</a></tt><tt class="py-op">,</tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt>  <tt class="py-line">                             <tt id="link-63" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-63', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="modbus_tk.defines.READ_INPUT_REGISTERS" class="py-name" href="#" onclick="return doclink('link-64', 'READ_INPUT_REGISTERS', 'link-18');">READ_INPUT_REGISTERS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Method modbus_tk.modbus.Slave._read_input_registers()=modbus_tk.modbus.Slave-class.html#_read_input_registers"><a title="modbus_tk.modbus.Slave._read_input_registers" class="py-name" href="#" onclick="return doclink('link-65', '_read_input_registers', 'link-65');">_read_input_registers</a></tt><tt class="py-op">,</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line">                             <tt id="link-66" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-66', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="modbus_tk.defines.READ_HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-67', 'READ_HOLDING_REGISTERS', 'link-20');">READ_HOLDING_REGISTERS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Method modbus_tk.modbus.Slave._read_holding_registers()=modbus_tk.modbus.Slave-class.html#_read_holding_registers"><a title="modbus_tk.modbus.Slave._read_holding_registers" class="py-name" href="#" onclick="return doclink('link-68', '_read_holding_registers', 'link-68');">_read_holding_registers</a></tt><tt class="py-op">,</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line">                             <tt id="link-69" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-69', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="modbus_tk.defines.WRITE_SINGLE_COIL" class="py-name" href="#" onclick="return doclink('link-70', 'WRITE_SINGLE_COIL', 'link-23');">WRITE_SINGLE_COIL</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Method modbus_tk.modbus.Slave._write_single_coil()=modbus_tk.modbus.Slave-class.html#_write_single_coil"><a title="modbus_tk.modbus.Slave._write_single_coil" class="py-name" href="#" onclick="return doclink('link-71', '_write_single_coil', 'link-71');">_write_single_coil</a></tt><tt class="py-op">,</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line">                             <tt id="link-72" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-72', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="modbus_tk.defines.WRITE_SINGLE_REGISTER" class="py-name" href="#" onclick="return doclink('link-73', 'WRITE_SINGLE_REGISTER', 'link-25');">WRITE_SINGLE_REGISTER</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name" targets="Method modbus_tk.modbus.Slave._write_single_register()=modbus_tk.modbus.Slave-class.html#_write_single_register"><a title="modbus_tk.modbus.Slave._write_single_register" class="py-name" href="#" onclick="return doclink('link-74', '_write_single_register', 'link-74');">_write_single_register</a></tt><tt class="py-op">,</tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt>  <tt class="py-line">                             <tt id="link-75" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-75', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="modbus_tk.defines.WRITE_MULTIPLE_COILS" class="py-name" href="#" onclick="return doclink('link-76', 'WRITE_MULTIPLE_COILS', 'link-30');">WRITE_MULTIPLE_COILS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name" targets="Method modbus_tk.modbus.Slave._write_multiple_coils()=modbus_tk.modbus.Slave-class.html#_write_multiple_coils"><a title="modbus_tk.modbus.Slave._write_multiple_coils" class="py-name" href="#" onclick="return doclink('link-77', '_write_multiple_coils', 'link-77');">_write_multiple_coils</a></tt><tt class="py-op">,</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line">                             <tt id="link-78" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-78', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="modbus_tk.defines.WRITE_MULTIPLE_REGISTERS" class="py-name" href="#" onclick="return doclink('link-79', 'WRITE_MULTIPLE_REGISTERS', 'link-35');">WRITE_MULTIPLE_REGISTERS</a></tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name" targets="Method modbus_tk.modbus.Slave._write_multiple_registers()=modbus_tk.modbus.Slave-class.html#_write_multiple_registers"><a title="modbus_tk.modbus.Slave._write_multiple_registers" class="py-name" href="#" onclick="return doclink('link-80', '_write_multiple_registers', 'link-80');">_write_multiple_registers</a></tt><tt class="py-op">,</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line">                             <tt class="py-op">}</tt> </tt>
</div><a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line">     </tt>
<a name="Slave._get_block_and_offset"></a><div id="Slave._get_block_and_offset-def"><a name="L413"></a><tt class="py-lineno">413</tt> <a class="py-toggle" href="#" id="Slave._get_block_and_offset-toggle" onclick="return toggle('Slave._get_block_and_offset');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_get_block_and_offset">_get_block_and_offset</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_type</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">,</tt> <tt class="py-param">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._get_block_and_offset-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._get_block_and_offset-expanded"><a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line">        <tt class="py-docstring">"""returns the block and offset corresponding to the given address"""</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">block</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">address</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt><tt class="py-op">:</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line">                <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">address</tt> <tt class="py-op">-</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">length</tt><tt class="py-op">:</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line">                    <tt class="py-keyword">return</tt> <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt>  <tt class="py-line">                 </tt>
<a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-81" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-81', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-82" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-82', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-83" class="py-name" targets="Variable modbus_tk.defines.ILLEGAL_DATA_ADDRESS=modbus_tk.defines-module.html#ILLEGAL_DATA_ADDRESS"><a title="modbus_tk.defines.ILLEGAL_DATA_ADDRESS" class="py-name" href="#" onclick="return doclink('link-83', 'ILLEGAL_DATA_ADDRESS', 'link-83');">ILLEGAL_DATA_ADDRESS</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line">     </tt>
<a name="Slave._read_digital"></a><div id="Slave._read_digital-def"><a name="L423"></a><tt class="py-lineno">423</tt> <a class="py-toggle" href="#" id="Slave._read_digital-toggle" onclick="return toggle('Slave._read_digital');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_digital">_read_digital</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_type</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_digital-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_digital-expanded"><a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line">        <tt class="py-docstring">"""read the value of coils and discrete inputs"""</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-84', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">5</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line">                 </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt><tt class="py-op">&gt;</tt><tt class="py-number">2000</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line">            <tt class="py-comment"># maximum allowed size is 2000 bits in one reading</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-85" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-85', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-86', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-87" class="py-name" targets="Variable modbus_tk.defines.ILLEGAL_DATA_VALUE=modbus_tk.defines-module.html#ILLEGAL_DATA_VALUE"><a title="modbus_tk.defines.ILLEGAL_DATA_VALUE" class="py-name" href="#" onclick="return doclink('link-87', 'ILLEGAL_DATA_VALUE', 'link-87');">ILLEGAL_DATA_VALUE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line">                 </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name" targets="Method modbus_tk.modbus.Slave._get_block_and_offset()=modbus_tk.modbus.Slave-class.html#_get_block_and_offset"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-88', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line">         </tt>
<a name="L433"></a><tt class="py-lineno">433</tt>  <tt class="py-line">        <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">:</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">quantity_of_x</tt><tt class="py-op">]</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line">         </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line">        <tt class="py-comment">#pack bits in bytes</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line">        <tt class="py-name">byte_count</tt> <tt class="py-op">=</tt> <tt class="py-name">quantity_of_x</tt> <tt class="py-op">/</tt> <tt class="py-number">8</tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">%</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line">            <tt class="py-name">byte_count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line">         </tt>
<a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line">        <tt class="py-comment"># write the response header</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line">        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-89', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">byte_count</tt><tt class="py-op">)</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line">         </tt>
<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">coil</tt> <tt class="py-keyword">in</tt> <tt class="py-name">values</tt><tt class="py-op">:</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">coil</tt><tt class="py-op">:</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt>  <tt class="py-line">                <tt class="py-name">byte_value</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-number">1</tt> <tt class="py-op">&lt;&lt;</tt> <tt class="py-name">i</tt><tt class="py-op">)</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">&gt;=</tt> <tt class="py-number">7</tt><tt class="py-op">:</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line">                <tt class="py-comment"># write the values of 8 bits in a byte</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line">                <tt class="py-name">response</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-90', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt><tt class="py-op">)</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line">                <tt class="py-comment">#reset the counters</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line">                <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line">                <tt class="py-name">i</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line">             </tt>
<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line">        <tt class="py-comment">#if there is remaining bits: add one more byte with their values</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line">            <tt class="py-name">response</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-91', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">byte_value</tt><tt class="py-op">)</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
</div><a name="L459"></a><tt class="py-lineno">459</tt>  <tt class="py-line">     </tt>
<a name="Slave._read_coils"></a><div id="Slave._read_coils-def"><a name="L460"></a><tt class="py-lineno">460</tt> <a class="py-toggle" href="#" id="Slave._read_coils-toggle" onclick="return toggle('Slave._read_coils');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_coils">_read_coils</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_coils-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_coils-expanded"><a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line">        <tt class="py-docstring">"""handle read coils modbus function"""</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name" targets="Method modbus_tk.modbus.Slave._read_digital()=modbus_tk.modbus.Slave-class.html#_read_digital"><a title="modbus_tk.modbus.Slave._read_digital" class="py-name" href="#" onclick="return doclink('link-92', '_read_digital', 'link-92');">_read_digital</a></tt><tt class="py-op">(</tt><tt id="link-93" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-93', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name" targets="Variable modbus_tk.defines.COILS=modbus_tk.defines-module.html#COILS"><a title="modbus_tk.defines.COILS" class="py-name" href="#" onclick="return doclink('link-94', 'COILS', 'link-94');">COILS</a></tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
</div><a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"> </tt>
<a name="Slave._read_discrete_inputs"></a><div id="Slave._read_discrete_inputs-def"><a name="L464"></a><tt class="py-lineno">464</tt> <a class="py-toggle" href="#" id="Slave._read_discrete_inputs-toggle" onclick="return toggle('Slave._read_discrete_inputs');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_discrete_inputs">_read_discrete_inputs</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_discrete_inputs-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_discrete_inputs-expanded"><a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line">        <tt class="py-docstring">"""handle read coils modbus function"""</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="modbus_tk.modbus.Slave._read_digital" class="py-name" href="#" onclick="return doclink('link-95', '_read_digital', 'link-92');">_read_digital</a></tt><tt class="py-op">(</tt><tt id="link-96" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-96', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-97" class="py-name" targets="Variable modbus_tk.defines.DISCRETE_INPUTS=modbus_tk.defines-module.html#DISCRETE_INPUTS"><a title="modbus_tk.defines.DISCRETE_INPUTS" class="py-name" href="#" onclick="return doclink('link-97', 'DISCRETE_INPUTS', 'link-97');">DISCRETE_INPUTS</a></tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
</div><a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"> </tt>
<a name="Slave._read_registers"></a><div id="Slave._read_registers-def"><a name="L468"></a><tt class="py-lineno">468</tt> <a class="py-toggle" href="#" id="Slave._read_registers-toggle" onclick="return toggle('Slave._read_registers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_registers">_read_registers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_type</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_registers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_registers-expanded"><a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line">        <tt class="py-docstring">"""read the value of holding and input registers"""</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-98', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">5</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line">         </tt>
<a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">125</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line">            <tt class="py-comment"># maximum allowed size is 125 registers in one reading</tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line">            <tt id="link-99" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-99', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"quantity_of_x is %d"</tt> <tt class="py-op">%</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-100" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-100', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-101" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-101', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="modbus_tk.defines.ILLEGAL_DATA_VALUE" class="py-name" href="#" onclick="return doclink('link-102', 'ILLEGAL_DATA_VALUE', 'link-87');">ILLEGAL_DATA_VALUE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line">         </tt>
<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line">        <tt class="py-comment"># look for the block corresponding to the request</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-103', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line">         </tt>
<a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line">        <tt class="py-comment">#get the values</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line">        <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">:</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">quantity_of_x</tt><tt class="py-op">]</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line">             </tt>
<a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line">        <tt class="py-comment">#write the response header</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt>  <tt class="py-line">        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-104', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt> <tt class="py-op">*</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line">        <tt class="py-comment">#add the values of every register on 2 bytes</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">reg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">values</tt><tt class="py-op">:</tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line">            <tt class="py-name">response</tt> <tt class="py-op">+=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-105', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;H"</tt><tt class="py-op">,</tt> <tt class="py-name">reg</tt><tt class="py-op">)</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
</div><a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line"> </tt>
<a name="Slave._read_holding_registers"></a><div id="Slave._read_holding_registers-def"><a name="L490"></a><tt class="py-lineno">490</tt> <a class="py-toggle" href="#" id="Slave._read_holding_registers-toggle" onclick="return toggle('Slave._read_holding_registers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_holding_registers">_read_holding_registers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_holding_registers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_holding_registers-expanded"><a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line">        <tt class="py-docstring">"""handle read coils modbus function"""</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name" targets="Method modbus_tk.modbus.Slave._read_registers()=modbus_tk.modbus.Slave-class.html#_read_registers"><a title="modbus_tk.modbus.Slave._read_registers" class="py-name" href="#" onclick="return doclink('link-106', '_read_registers', 'link-106');">_read_registers</a></tt><tt class="py-op">(</tt><tt id="link-107" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-107', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-108" class="py-name" targets="Variable modbus_tk.defines.HOLDING_REGISTERS=modbus_tk.defines-module.html#HOLDING_REGISTERS"><a title="modbus_tk.defines.HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-108', 'HOLDING_REGISTERS', 'link-108');">HOLDING_REGISTERS</a></tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
</div><a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line"> </tt>
<a name="Slave._read_input_registers"></a><div id="Slave._read_input_registers-def"><a name="L494"></a><tt class="py-lineno">494</tt> <a class="py-toggle" href="#" id="Slave._read_input_registers-toggle" onclick="return toggle('Slave._read_input_registers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_read_input_registers">_read_input_registers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._read_input_registers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._read_input_registers-expanded"><a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line">        <tt class="py-docstring">"""handle read coils modbus function"""</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="modbus_tk.modbus.Slave._read_registers" class="py-name" href="#" onclick="return doclink('link-109', '_read_registers', 'link-106');">_read_registers</a></tt><tt class="py-op">(</tt><tt id="link-110" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-110', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-111" class="py-name" targets="Variable modbus_tk.defines.ANALOG_INPUTS=modbus_tk.defines-module.html#ANALOG_INPUTS"><a title="modbus_tk.defines.ANALOG_INPUTS" class="py-name" href="#" onclick="return doclink('link-111', 'ANALOG_INPUTS', 'link-111');">ANALOG_INPUTS</a></tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
</div><a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line">         </tt>
<a name="Slave._write_multiple_registers"></a><div id="Slave._write_multiple_registers-def"><a name="L498"></a><tt class="py-lineno">498</tt> <a class="py-toggle" href="#" id="Slave._write_multiple_registers-toggle" onclick="return toggle('Slave._write_multiple_registers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_write_multiple_registers">_write_multiple_registers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._write_multiple_registers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._write_multiple_registers-expanded"><a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line">        <tt class="py-docstring">"""execute modbus function 16"""</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt>  <tt class="py-line">        <tt class="py-comment"># get the starting address and the number of items from the request pdu</tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">,</tt> <tt class="py-name">byte_count</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-112', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHB"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">6</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt>  <tt class="py-line">         </tt>
<a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">123</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">byte_count</tt> <tt class="py-op">!=</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">*</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line">            <tt class="py-comment"># maximum allowed size is 123 registers in one reading</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-113" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-113', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-114" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-114', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="modbus_tk.defines.ILLEGAL_DATA_VALUE" class="py-name" href="#" onclick="return doclink('link-115', 'ILLEGAL_DATA_VALUE', 'link-87');">ILLEGAL_DATA_VALUE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line">         </tt>
<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line">        <tt class="py-comment"># look for the block corresponding to the request</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-116', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt id="link-117" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-117', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="modbus_tk.defines.HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-118', 'HOLDING_REGISTERS', 'link-108');">HOLDING_REGISTERS</a></tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line">         </tt>
<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line">        <tt class="py-name">count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line">            <tt class="py-name">count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt>  <tt class="py-line">            <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-119', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;H"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-number">2</tt><tt class="py-op">*</tt><tt class="py-name">i</tt><tt class="py-op">:</tt><tt class="py-number">8</tt><tt class="py-op">+</tt><tt class="py-number">2</tt><tt class="py-op">*</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line">         </tt>
<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-120', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">count</tt><tt class="py-op">)</tt> </tt>
</div><a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line">         </tt>
<a name="Slave._write_multiple_coils"></a><div id="Slave._write_multiple_coils-def"><a name="L517"></a><tt class="py-lineno">517</tt> <a class="py-toggle" href="#" id="Slave._write_multiple_coils-toggle" onclick="return toggle('Slave._write_multiple_coils');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_write_multiple_coils">_write_multiple_coils</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._write_multiple_coils-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._write_multiple_coils-expanded"><a name="L518"></a><tt class="py-lineno">518</tt>  <tt class="py-line">        <tt class="py-docstring">"""execute modbus function 15"""</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line">        <tt class="py-comment"># get the starting address and the number of items from the request pdu</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">,</tt> <tt class="py-name">byte_count</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-121', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHB"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">6</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt>  <tt class="py-line">  </tt>
<a name="L522"></a><tt class="py-lineno">522</tt>  <tt class="py-line">        <tt class="py-name">expected_byte_count</tt> <tt class="py-op">=</tt> <tt class="py-name">quantity_of_x</tt> <tt class="py-op">/</tt> <tt class="py-number">8</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">%</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt>  <tt class="py-line">            <tt class="py-name">expected_byte_count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt>  <tt class="py-line">         </tt>
<a name="L526"></a><tt class="py-lineno">526</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">quantity_of_x</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">1968</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">byte_count</tt> <tt class="py-op">!=</tt> <tt class="py-name">expected_byte_count</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt>  <tt class="py-line">            <tt class="py-comment"># maximum allowed size is 1968 coils</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-122" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-122', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-123" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-123', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="modbus_tk.defines.ILLEGAL_DATA_VALUE" class="py-name" href="#" onclick="return doclink('link-124', 'ILLEGAL_DATA_VALUE', 'link-87');">ILLEGAL_DATA_VALUE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt>  <tt class="py-line">         </tt>
<a name="L530"></a><tt class="py-lineno">530</tt>  <tt class="py-line">        <tt class="py-comment"># look for the block corresponding to the request</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-125', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt id="link-126" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-126', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="modbus_tk.defines.COILS" class="py-name" href="#" onclick="return doclink('link-127', 'COILS', 'link-94');">COILS</a></tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">)</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt>  <tt class="py-line">         </tt>
<a name="L533"></a><tt class="py-lineno">533</tt>  <tt class="py-line">        <tt class="py-name">count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-name">byte_count</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">count</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">:</tt> </tt>
<a name="L536"></a><tt class="py-lineno">536</tt>  <tt class="py-line">                <tt class="py-keyword">break</tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">byte_value</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-128', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L538"></a><tt class="py-lineno">538</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">j</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-number">8</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">byte_value</tt> <tt class="py-op">&amp;</tt> <tt class="py-op">(</tt><tt class="py-number">1</tt> <tt class="py-op">&lt;&lt;</tt> <tt class="py-name">j</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt>  <tt class="py-line">                    <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">i</tt><tt class="py-op">*</tt><tt class="py-number">8</tt><tt class="py-op">+</tt><tt class="py-name">j</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt>  <tt class="py-line">                    <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">i</tt><tt class="py-op">*</tt><tt class="py-number">8</tt><tt class="py-op">+</tt><tt class="py-name">j</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">count</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">quantity_of_x</tt><tt class="py-op">:</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt>  <tt class="py-line">                    <tt class="py-keyword">break</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt>  <tt class="py-line">                <tt class="py-name">count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-129', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">count</tt><tt class="py-op">)</tt> </tt>
</div><a name="L547"></a><tt class="py-lineno">547</tt>  <tt class="py-line">     </tt>
<a name="Slave._write_single_register"></a><div id="Slave._write_single_register-def"><a name="L548"></a><tt class="py-lineno">548</tt> <a class="py-toggle" href="#" id="Slave._write_single_register-toggle" onclick="return toggle('Slave._write_single_register');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_write_single_register">_write_single_register</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._write_single_register-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._write_single_register-expanded"><a name="L549"></a><tt class="py-lineno">549</tt>  <tt class="py-line">        <tt class="py-docstring">"""execute modbus function 6"""</tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">data_address</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-130', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">5</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-131', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt id="link-132" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-132', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="modbus_tk.defines.HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-133', 'HOLDING_REGISTERS', 'link-108');">HOLDING_REGISTERS</a></tt><tt class="py-op">,</tt> <tt class="py-name">data_address</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-comment">#returns echo of the command</tt> </tt>
</div><a name="L554"></a><tt class="py-lineno">554</tt>  <tt class="py-line">     </tt>
<a name="Slave._write_single_coil"></a><div id="Slave._write_single_coil-def"><a name="L555"></a><tt class="py-lineno">555</tt> <a class="py-toggle" href="#" id="Slave._write_single_coil-toggle" onclick="return toggle('Slave._write_single_coil');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_write_single_coil">_write_single_coil</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._write_single_coil-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._write_single_coil-expanded"><a name="L556"></a><tt class="py-lineno">556</tt>  <tt class="py-line">        <tt class="py-docstring">"""execute modbus function 5"""</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">data_address</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-134', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HH"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">5</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt>  <tt class="py-line">        <tt class="py-name">block</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="modbus_tk.modbus.Slave._get_block_and_offset" class="py-name" href="#" onclick="return doclink('link-135', '_get_block_and_offset', 'link-88');">_get_block_and_offset</a></tt><tt class="py-op">(</tt><tt id="link-136" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-136', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="modbus_tk.defines.COILS" class="py-name" href="#" onclick="return doclink('link-137', 'COILS', 'link-94');">COILS</a></tt><tt class="py-op">,</tt> <tt class="py-name">data_address</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt>  <tt class="py-line">            <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">value</tt> <tt class="py-op">==</tt> <tt class="py-number">0xff00</tt><tt class="py-op">:</tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt>  <tt class="py-line">            <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-138" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-138', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-139', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="modbus_tk.defines.ILLEGAL_DATA_VALUE" class="py-name" href="#" onclick="return doclink('link-140', 'ILLEGAL_DATA_VALUE', 'link-87');">ILLEGAL_DATA_VALUE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-comment">#returns echo of the command</tt> </tt>
</div><a name="L566"></a><tt class="py-lineno">566</tt>  <tt class="py-line"> </tt>
<a name="Slave.handle_request"></a><div id="Slave.handle_request-def"><a name="L567"></a><tt class="py-lineno">567</tt> <a class="py-toggle" href="#" id="Slave.handle_request-toggle" onclick="return toggle('Slave.handle_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#handle_request">handle_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_pdu</tt><tt class="py-op">,</tt> <tt class="py-param">broadcast</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.handle_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.handle_request-expanded"><a name="L568"></a><tt class="py-lineno">568</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt>  <tt class="py-line"><tt class="py-docstring">        parse the request pdu, makes the corresponding action</tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt>  <tt class="py-line"><tt class="py-docstring">        and returns the response pdu</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt>  <tt class="py-line">                <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-141" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-141', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Slave.handle_request"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L575"></a><tt class="py-lineno">575</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L576"></a><tt class="py-lineno">576</tt>  <tt class="py-line">                    <tt class="py-keyword">return</tt> <tt class="py-name">retval</tt> </tt>
<a name="L577"></a><tt class="py-lineno">577</tt>  <tt class="py-line">                 </tt>
<a name="L578"></a><tt class="py-lineno">578</tt>  <tt class="py-line">                <tt class="py-comment"># get the function code</tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt>  <tt class="py-line">                <tt class="py-op">(</tt><tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-142" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-142', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt>  <tt class="py-line">                 </tt>
<a name="L581"></a><tt class="py-lineno">581</tt>  <tt class="py-line">                <tt class="py-comment"># check if the function code is valid. If not returns error response</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fn_code_map</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">function_code</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt>  <tt class="py-line">                    <tt class="py-keyword">raise</tt> <tt id="link-143" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-143', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">(</tt><tt id="link-144" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-144', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-145" class="py-name" targets="Variable modbus_tk.defines.ILLEGAL_FUNCTION=modbus_tk.defines-module.html#ILLEGAL_FUNCTION"><a title="modbus_tk.defines.ILLEGAL_FUNCTION" class="py-name" href="#" onclick="return doclink('link-145', 'ILLEGAL_FUNCTION', 'link-145');">ILLEGAL_FUNCTION</a></tt><tt class="py-op">)</tt> </tt>
<a name="L584"></a><tt class="py-lineno">584</tt>  <tt class="py-line">                 </tt>
<a name="L585"></a><tt class="py-lineno">585</tt>  <tt class="py-line">                <tt class="py-comment"># if read query is broadcasted raises an error</tt> </tt>
<a name="L586"></a><tt class="py-lineno">586</tt>  <tt class="py-line">                <tt class="py-name">cant_be_broadcasted</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-146" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-146', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="modbus_tk.defines.READ_COILS" class="py-name" href="#" onclick="return doclink('link-147', 'READ_COILS', 'link-13');">READ_COILS</a></tt><tt class="py-op">,</tt> <tt id="link-148" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-148', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="modbus_tk.defines.READ_DISCRETE_INPUTS" class="py-name" href="#" onclick="return doclink('link-149', 'READ_DISCRETE_INPUTS', 'link-15');">READ_DISCRETE_INPUTS</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L587"></a><tt class="py-lineno">587</tt>  <tt class="py-line">                                      <tt id="link-150" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-150', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-151" class="py-name"><a title="modbus_tk.defines.READ_INPUT_REGISTERS" class="py-name" href="#" onclick="return doclink('link-151', 'READ_INPUT_REGISTERS', 'link-18');">READ_INPUT_REGISTERS</a></tt><tt class="py-op">,</tt> <tt id="link-152" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-152', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="modbus_tk.defines.READ_HOLDING_REGISTERS" class="py-name" href="#" onclick="return doclink('link-153', 'READ_HOLDING_REGISTERS', 'link-20');">READ_HOLDING_REGISTERS</a></tt><tt class="py-op">)</tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">broadcast</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">function_code</tt> <tt class="py-keyword">in</tt> <tt class="py-name">cant_be_broadcasted</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt>  <tt class="py-line">                    <tt class="py-keyword">raise</tt> <tt id="link-154" class="py-name" targets="Class modbus_tk.modbus.ModbusInvalidRequestError=modbus_tk.modbus.ModbusInvalidRequestError-class.html"><a title="modbus_tk.modbus.ModbusInvalidRequestError" class="py-name" href="#" onclick="return doclink('link-154', 'ModbusInvalidRequestError', 'link-154');">ModbusInvalidRequestError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Function %d can not be broadcasted"</tt> <tt class="py-op">%</tt> <tt class="py-name">function_code</tt><tt class="py-op">)</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt>  <tt class="py-line">                                 </tt>
<a name="L591"></a><tt class="py-lineno">591</tt>  <tt class="py-line">                <tt class="py-comment">#execute the corresponding function</tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt>  <tt class="py-line">                <tt class="py-name">response_pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fn_code_map</tt><tt class="py-op">[</tt><tt class="py-name">function_code</tt><tt class="py-op">]</tt><tt class="py-op">(</tt><tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">:</tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">broadcast</tt><tt class="py-op">:</tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt>  <tt class="py-line">                        <tt id="link-155" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-155', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Slave.on_handle_broadcast"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt>  <tt class="py-line">                        <tt id="link-156" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-156', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"broadcast: %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-157" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-157', 'utils', 'link-1');">utils</a></tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="modbus_tk.utils.get_log_buffer" class="py-name" href="#" onclick="return doclink('link-158', 'get_log_buffer', 'link-44');">get_log_buffer</a></tt><tt class="py-op">(</tt><tt class="py-string">"!!"</tt><tt class="py-op">,</tt> <tt class="py-name">response_pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L597"></a><tt class="py-lineno">597</tt>  <tt class="py-line">                        <tt class="py-keyword">return</tt> <tt class="py-string">""</tt> </tt>
<a name="L598"></a><tt class="py-lineno">598</tt>  <tt class="py-line">                    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L599"></a><tt class="py-lineno">599</tt>  <tt class="py-line">                        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-159', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">response_pdu</tt> </tt>
<a name="L600"></a><tt class="py-lineno">600</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"No response for function %d"</tt> <tt class="py-op">%</tt> <tt class="py-name">function_code</tt><tt class="py-op">)</tt> </tt>
<a name="L601"></a><tt class="py-lineno">601</tt>  <tt class="py-line">                     </tt>
<a name="L602"></a><tt class="py-lineno">602</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt id="link-160" class="py-name"><a title="modbus_tk.modbus.ModbusError" class="py-name" href="#" onclick="return doclink('link-160', 'ModbusError', 'link-54');">ModbusError</a></tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">:</tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt>  <tt class="py-line">                <tt id="link-161" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-161', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">excpt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt>  <tt class="py-line">                <tt id="link-162" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-162', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Slave.on_exception"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-163', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BB"</tt><tt class="py-op">,</tt> <tt class="py-name">function_code</tt><tt class="py-op">+</tt><tt class="py-number">128</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name" targets="Method modbus_tk.modbus.ModbusError.get_exception_code()=modbus_tk.modbus.ModbusError-class.html#get_exception_code"><a title="modbus_tk.modbus.ModbusError.get_exception_code" class="py-name" href="#" onclick="return doclink('link-164', 'get_exception_code', 'link-164');">get_exception_code</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L606"></a><tt class="py-lineno">606</tt>  <tt class="py-line">     </tt>
<a name="L607"></a><tt class="py-lineno">607</tt>  <tt class="py-line">     </tt>
<a name="Slave.add_block"></a><div id="Slave.add_block-def"><a name="L608"></a><tt class="py-lineno">608</tt> <a class="py-toggle" href="#" id="Slave.add_block-toggle" onclick="return toggle('Slave.add_block');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#add_block">add_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_name</tt><tt class="py-op">,</tt> <tt class="py-param">block_type</tt><tt class="py-op">,</tt> <tt class="py-param">starting_address</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.add_block-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.add_block-expanded"><a name="L609"></a><tt class="py-lineno">609</tt>  <tt class="py-line">        <tt class="py-docstring">"""Add a new block identified by its name"""</tt>  </tt>
<a name="L610"></a><tt class="py-lineno">610</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L611"></a><tt class="py-lineno">611</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">size</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L612"></a><tt class="py-lineno">612</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-165" class="py-name" targets="Class modbus_tk.modbus.InvalidArgumentError=modbus_tk.modbus.InvalidArgumentError-class.html"><a title="modbus_tk.modbus.InvalidArgumentError" class="py-name" href="#" onclick="return doclink('link-165', 'InvalidArgumentError', 'link-165');">InvalidArgumentError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"size must be a positive number"</tt> </tt>
<a name="L613"></a><tt class="py-lineno">613</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">starting_address</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L614"></a><tt class="py-lineno">614</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-166" class="py-name"><a title="modbus_tk.modbus.InvalidArgumentError" class="py-name" href="#" onclick="return doclink('link-166', 'InvalidArgumentError', 'link-165');">InvalidArgumentError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"starting address must be zero or positive number"</tt> </tt>
<a name="L615"></a><tt class="py-lineno">615</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno">616</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-167" class="py-name" targets="Class modbus_tk.modbus.DuplicatedKeyError=modbus_tk.modbus.DuplicatedKeyError-class.html"><a title="modbus_tk.modbus.DuplicatedKeyError" class="py-name" href="#" onclick="return doclink('link-167', 'DuplicatedKeyError', 'link-167');">DuplicatedKeyError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Block %s already exists. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt>  <tt class="py-line">             </tt>
<a name="L618"></a><tt class="py-lineno">618</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L619"></a><tt class="py-lineno">619</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-168" class="py-name" targets="Class modbus_tk.modbus.InvalidModbusBlockError=modbus_tk.modbus.InvalidModbusBlockError-class.html"><a title="modbus_tk.modbus.InvalidModbusBlockError" class="py-name" href="#" onclick="return doclink('link-168', 'InvalidModbusBlockError', 'link-168');">InvalidModbusBlockError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Invalid block type %d"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">)</tt>     </tt>
<a name="L620"></a><tt class="py-lineno">620</tt>  <tt class="py-line">             </tt>
<a name="L621"></a><tt class="py-lineno">621</tt>  <tt class="py-line">            <tt class="py-comment"># check that the new block doesn't overlap an existing block</tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt>  <tt class="py-line">            <tt class="py-comment"># it means that only 1 block per type must correspond to a given address</tt> </tt>
<a name="L623"></a><tt class="py-lineno">623</tt>  <tt class="py-line">            <tt class="py-comment"># for example: it must not have 2 holding registers at address 100</tt> </tt>
<a name="L624"></a><tt class="py-lineno">624</tt>  <tt class="py-line">            <tt class="py-name">index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L625"></a><tt class="py-lineno">625</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L626"></a><tt class="py-lineno">626</tt>  <tt class="py-line">                <tt class="py-name">block</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name" targets="Method modbus_tk.modbus.ModbusBlock.is_in()=modbus_tk.modbus.ModbusBlock-class.html#is_in"><a title="modbus_tk.modbus.ModbusBlock.is_in" class="py-name" href="#" onclick="return doclink('link-169', 'is_in', 'link-169');">is_in</a></tt><tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt>  <tt class="py-line">                    <tt class="py-keyword">raise</tt> <tt id="link-170" class="py-name" targets="Class modbus_tk.modbus.OverlapModbusBlockError=modbus_tk.modbus.OverlapModbusBlockError-class.html"><a title="modbus_tk.modbus.OverlapModbusBlockError" class="py-name" href="#" onclick="return doclink('link-170', 'OverlapModbusBlockError', 'link-170');">OverlapModbusBlockError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Overlap block at %d size %d"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">size</tt><tt class="py-op">)</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">starting_address</tt><tt class="py-op">:</tt> </tt>
<a name="L630"></a><tt class="py-lineno">630</tt>  <tt class="py-line">                    <tt class="py-name">index</tt> <tt class="py-op">=</tt> <tt class="py-name">i</tt>     </tt>
<a name="L631"></a><tt class="py-lineno">631</tt>  <tt class="py-line">                    <tt class="py-keyword">break</tt> </tt>
<a name="L632"></a><tt class="py-lineno">632</tt>  <tt class="py-line">             </tt>
<a name="L633"></a><tt class="py-lineno">633</tt>  <tt class="py-line">            <tt class="py-comment"># if the block is ok: register it</tt> </tt>
<a name="L634"></a><tt class="py-lineno">634</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">[</tt><tt class="py-name">block_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">)</tt> </tt>
<a name="L635"></a><tt class="py-lineno">635</tt>  <tt class="py-line">            <tt class="py-comment"># add it in the 'per type' shortcut </tt> </tt>
<a name="L636"></a><tt class="py-lineno">636</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-name">index</tt><tt class="py-op">,</tt> <tt id="link-171" class="py-name" targets="Class modbus_tk.modbus.ModbusBlock=modbus_tk.modbus.ModbusBlock-class.html"><a title="modbus_tk.modbus.ModbusBlock" class="py-name" href="#" onclick="return doclink('link-171', 'ModbusBlock', 'link-171');">ModbusBlock</a></tt><tt class="py-op">(</tt><tt class="py-name">starting_address</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L637"></a><tt class="py-lineno">637</tt>  <tt class="py-line">     </tt>
<a name="Slave.remove_block"></a><div id="Slave.remove_block-def"><a name="L638"></a><tt class="py-lineno">638</tt> <a class="py-toggle" href="#" id="Slave.remove_block-toggle" onclick="return toggle('Slave.remove_block');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#remove_block">remove_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.remove_block-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.remove_block-expanded"><a name="L639"></a><tt class="py-lineno">639</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L640"></a><tt class="py-lineno">640</tt>  <tt class="py-line"><tt class="py-docstring">        Remove the block with the given name.</tt> </tt>
<a name="L641"></a><tt class="py-lineno">641</tt>  <tt class="py-line"><tt class="py-docstring">        Raise an exception if not found</tt> </tt>
<a name="L642"></a><tt class="py-lineno">642</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L643"></a><tt class="py-lineno">643</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread safe</tt> </tt>
<a name="L644"></a><tt class="py-lineno">644</tt>  <tt class="py-line">            <tt class="py-name">block</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name" targets="Method modbus_tk.modbus.Slave._get_block()=modbus_tk.modbus.Slave-class.html#_get_block"><a title="modbus_tk.modbus.Slave._get_block" class="py-name" href="#" onclick="return doclink('link-172', '_get_block', 'link-172');">_get_block</a></tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
<a name="L645"></a><tt class="py-lineno">645</tt>  <tt class="py-line">             </tt>
<a name="L646"></a><tt class="py-lineno">646</tt>  <tt class="py-line">            <tt class="py-comment"># the block has been found: remove it from the shortcut</tt> </tt>
<a name="L647"></a><tt class="py-lineno">647</tt>  <tt class="py-line">            <tt class="py-name">block_type</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L648"></a><tt class="py-lineno">648</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">block</tt><tt class="py-op">)</tt> </tt>
</div><a name="L649"></a><tt class="py-lineno">649</tt>  <tt class="py-line"> </tt>
<a name="Slave.remove_all_blocks"></a><div id="Slave.remove_all_blocks-def"><a name="L650"></a><tt class="py-lineno">650</tt> <a class="py-toggle" href="#" id="Slave.remove_all_blocks-toggle" onclick="return toggle('Slave.remove_all_blocks');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#remove_all_blocks">remove_all_blocks</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.remove_all_blocks-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.remove_all_blocks-expanded"><a name="L651"></a><tt class="py-lineno">651</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L652"></a><tt class="py-lineno">652</tt>  <tt class="py-line"><tt class="py-docstring">        Remove all the blocks</tt> </tt>
<a name="L653"></a><tt class="py-lineno">653</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L654"></a><tt class="py-lineno">654</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread safe</tt> </tt>
<a name="L655"></a><tt class="py-lineno">655</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">.</tt><tt class="py-name">clear</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L656"></a><tt class="py-lineno">656</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">:</tt> </tt>
<a name="L657"></a><tt class="py-lineno">657</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L658"></a><tt class="py-lineno">658</tt>  <tt class="py-line">     </tt>
<a name="Slave._get_block"></a><div id="Slave._get_block-def"><a name="L659"></a><tt class="py-lineno">659</tt> <a class="py-toggle" href="#" id="Slave._get_block-toggle" onclick="return toggle('Slave._get_block');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#_get_block">_get_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave._get_block-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave._get_block-expanded"><a name="L660"></a><tt class="py-lineno">660</tt>  <tt class="py-line">        <tt class="py-docstring">"""Find a block by its name and raise and exception if not found"""</tt> </tt>
<a name="L661"></a><tt class="py-lineno">661</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L662"></a><tt class="py-lineno">662</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-173" class="py-name" targets="Class modbus_tk.modbus.MissingKeyError=modbus_tk.modbus.MissingKeyError-class.html"><a title="modbus_tk.modbus.MissingKeyError" class="py-name" href="#" onclick="return doclink('link-173', 'MissingKeyError', 'link-173');">MissingKeyError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"block %s not found"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
<a name="L663"></a><tt class="py-lineno">663</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">block_type</tt><tt class="py-op">,</tt> <tt class="py-name">starting_address</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_blocks</tt><tt class="py-op">[</tt><tt class="py-name">block_name</tt><tt class="py-op">]</tt> </tt>
<a name="L664"></a><tt class="py-lineno">664</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">block</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_memory</tt><tt class="py-op">[</tt><tt class="py-name">block_type</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L665"></a><tt class="py-lineno">665</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> <tt class="py-op">==</tt> <tt class="py-name">starting_address</tt><tt class="py-op">:</tt> </tt>
<a name="L666"></a><tt class="py-lineno">666</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">block</tt> </tt>
<a name="L667"></a><tt class="py-lineno">667</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-string">"Bug?: the block %s is not registered properly in memory"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L668"></a><tt class="py-lineno">668</tt>  <tt class="py-line">     </tt>
<a name="Slave.set_values"></a><div id="Slave.set_values-def"><a name="L669"></a><tt class="py-lineno">669</tt> <a class="py-toggle" href="#" id="Slave.set_values-toggle" onclick="return toggle('Slave.set_values');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#set_values">set_values</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_name</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">,</tt> <tt class="py-param">values</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.set_values-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.set_values-expanded"><a name="L670"></a><tt class="py-lineno">670</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L671"></a><tt class="py-lineno">671</tt>  <tt class="py-line"><tt class="py-docstring">        Set the values of the items at the given address</tt> </tt>
<a name="L672"></a><tt class="py-lineno">672</tt>  <tt class="py-line"><tt class="py-docstring">        If values is a list or a tuple, the value of every item is written</tt> </tt>
<a name="L673"></a><tt class="py-lineno">673</tt>  <tt class="py-line"><tt class="py-docstring">        If values is a number, only one value is written</tt> </tt>
<a name="L674"></a><tt class="py-lineno">674</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L675"></a><tt class="py-lineno">675</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread safe</tt> </tt>
<a name="L676"></a><tt class="py-lineno">676</tt>  <tt class="py-line">            <tt class="py-name">block</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="modbus_tk.modbus.Slave._get_block" class="py-name" href="#" onclick="return doclink('link-174', '_get_block', 'link-172');">_get_block</a></tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
<a name="L677"></a><tt class="py-lineno">677</tt>  <tt class="py-line">             </tt>
<a name="L678"></a><tt class="py-lineno">678</tt>  <tt class="py-line">            <tt class="py-comment"># the block has been found</tt> </tt>
<a name="L679"></a><tt class="py-lineno">679</tt>  <tt class="py-line">            <tt class="py-comment"># check that it doesn't write out of the block</tt> </tt>
<a name="L680"></a><tt class="py-lineno">680</tt>  <tt class="py-line">            <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">address</tt><tt class="py-op">-</tt><tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> </tt>
<a name="L681"></a><tt class="py-lineno">681</tt>  <tt class="py-line">             </tt>
<a name="L682"></a><tt class="py-lineno">682</tt>  <tt class="py-line">            <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L683"></a><tt class="py-lineno">683</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L684"></a><tt class="py-lineno">684</tt>  <tt class="py-line">                <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> </tt>
<a name="L685"></a><tt class="py-lineno">685</tt>  <tt class="py-line">             </tt>
<a name="L686"></a><tt class="py-lineno">686</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">offset</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">offset</tt> <tt class="py-op">+</tt> <tt class="py-name">size</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L687"></a><tt class="py-lineno">687</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-175" class="py-name" targets="Class modbus_tk.modbus.OutOfModbusBlockError=modbus_tk.modbus.OutOfModbusBlockError-class.html"><a title="modbus_tk.modbus.OutOfModbusBlockError" class="py-name" href="#" onclick="return doclink('link-175', 'OutOfModbusBlockError', 'link-175');">OutOfModbusBlockError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"address %s size %d is out of block %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">address</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">,</tt> <tt class="py-name">block_name</tt><tt class="py-op">)</tt>     </tt>
<a name="L688"></a><tt class="py-lineno">688</tt>  <tt class="py-line">             </tt>
<a name="L689"></a><tt class="py-lineno">689</tt>  <tt class="py-line">            <tt class="py-comment">#if Ok: write the values</tt> </tt>
<a name="L690"></a><tt class="py-lineno">690</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L691"></a><tt class="py-lineno">691</tt>  <tt class="py-line">                <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">:</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">values</tt> </tt>
<a name="L692"></a><tt class="py-lineno">692</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L693"></a><tt class="py-lineno">693</tt>  <tt class="py-line">                <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">values</tt> </tt>
</div><a name="L694"></a><tt class="py-lineno">694</tt>  <tt class="py-line">     </tt>
<a name="Slave.get_values"></a><div id="Slave.get_values-def"><a name="L695"></a><tt class="py-lineno">695</tt> <a class="py-toggle" href="#" id="Slave.get_values-toggle" onclick="return toggle('Slave.get_values');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Slave-class.html#get_values">get_values</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">block_name</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Slave.get_values-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Slave.get_values-expanded"><a name="L696"></a><tt class="py-lineno">696</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L697"></a><tt class="py-lineno">697</tt>  <tt class="py-line"><tt class="py-docstring">        return the values of n items at the given address of the given block</tt> </tt>
<a name="L698"></a><tt class="py-lineno">698</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L699"></a><tt class="py-lineno">699</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data_lock</tt><tt class="py-op">:</tt> <tt class="py-comment">#thread safe</tt> </tt>
<a name="L700"></a><tt class="py-lineno">700</tt>  <tt class="py-line">            <tt class="py-name">block</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name"><a title="modbus_tk.modbus.Slave._get_block" class="py-name" href="#" onclick="return doclink('link-176', '_get_block', 'link-172');">_get_block</a></tt><tt class="py-op">(</tt><tt class="py-name">block_name</tt><tt class="py-op">)</tt> </tt>
<a name="L701"></a><tt class="py-lineno">701</tt>  <tt class="py-line">             </tt>
<a name="L702"></a><tt class="py-lineno">702</tt>  <tt class="py-line">            <tt class="py-comment"># the block has been found</tt> </tt>
<a name="L703"></a><tt class="py-lineno">703</tt>  <tt class="py-line">            <tt class="py-comment"># check that it doesn't write out of the block</tt> </tt>
<a name="L704"></a><tt class="py-lineno">704</tt>  <tt class="py-line">            <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">address</tt> <tt class="py-op">-</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">starting_address</tt> </tt>
<a name="L705"></a><tt class="py-lineno">705</tt>  <tt class="py-line">             </tt>
<a name="L706"></a><tt class="py-lineno">706</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">offset</tt><tt class="py-op">&lt;</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">offset</tt> <tt class="py-op">+</tt> <tt class="py-name">size</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L707"></a><tt class="py-lineno">707</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-177" class="py-name"><a title="modbus_tk.modbus.OutOfModbusBlockError" class="py-name" href="#" onclick="return doclink('link-177', 'OutOfModbusBlockError', 'link-175');">OutOfModbusBlockError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"address %s size %d is out of block %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">address</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">,</tt> <tt class="py-name">block_name</tt><tt class="py-op">)</tt>     </tt>
<a name="L708"></a><tt class="py-lineno">708</tt>  <tt class="py-line">             </tt>
<a name="L709"></a><tt class="py-lineno">709</tt>  <tt class="py-line">            <tt class="py-comment">#returns the values</tt> </tt>
<a name="L710"></a><tt class="py-lineno">710</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">size</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L711"></a><tt class="py-lineno">711</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno">712</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L713"></a><tt class="py-lineno">713</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">block</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">offset</tt><tt class="py-op">:</tt><tt class="py-name">offset</tt><tt class="py-op">+</tt><tt class="py-name">size</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L714"></a><tt class="py-lineno">714</tt>  <tt class="py-line"> </tt>
<a name="Databank"></a><div id="Databank-def"><a name="L715"></a><tt class="py-lineno">715</tt> <a class="py-toggle" href="#" id="Databank-toggle" onclick="return toggle('Databank');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html">Databank</a><tt class="py-op">:</tt> </tt>
</div><div id="Databank-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Databank-expanded"><a name="L716"></a><tt class="py-lineno">716</tt>  <tt class="py-line">    <tt class="py-docstring">"""A databank is a shared place containing the data of all slaves"""</tt> </tt>
<a name="L717"></a><tt class="py-lineno">717</tt>  <tt class="py-line"> </tt>
<a name="Databank.__init__"></a><div id="Databank.__init__-def"><a name="L718"></a><tt class="py-lineno">718</tt> <a class="py-toggle" href="#" id="Databank.__init__-toggle" onclick="return toggle('Databank.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.__init__-expanded"><a name="L719"></a><tt class="py-lineno">719</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor"""</tt> </tt>
<a name="L720"></a><tt class="py-lineno">720</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> <tt class="py-comment"># the map of slaves by ids</tt> </tt>
<a name="L721"></a><tt class="py-lineno">721</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name" targets="Variable modbus_tk.hooks._lock=modbus_tk.hooks-module.html#_lock"><a title="modbus_tk.hooks._lock" class="py-name" href="#" onclick="return doclink('link-178', '_lock', 'link-178');">_lock</a></tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># protect access to the map of slaves</tt> </tt>
</div><a name="L722"></a><tt class="py-lineno">722</tt>  <tt class="py-line">         </tt>
<a name="Databank.add_slave"></a><div id="Databank.add_slave-def"><a name="L723"></a><tt class="py-lineno">723</tt> <a class="py-toggle" href="#" id="Databank.add_slave-toggle" onclick="return toggle('Databank.add_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#add_slave">add_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.add_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.add_slave-expanded"><a name="L724"></a><tt class="py-lineno">724</tt>  <tt class="py-line">        <tt class="py-docstring">"""Add a new slave with the given id"""</tt> </tt>
<a name="L725"></a><tt class="py-lineno">725</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-179" class="py-name"><a title="modbus_tk.hooks._lock" class="py-name" href="#" onclick="return doclink('link-179', '_lock', 'link-178');">_lock</a></tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L726"></a><tt class="py-lineno">726</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">255</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L727"></a><tt class="py-lineno">727</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-string">"Invalid slave id %d"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
<a name="L728"></a><tt class="py-lineno">728</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L729"></a><tt class="py-lineno">729</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">[</tt><tt class="py-name">slave_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-180" class="py-name" targets="Class modbus_tk.modbus.Slave=modbus_tk.modbus.Slave-class.html"><a title="modbus_tk.modbus.Slave" class="py-name" href="#" onclick="return doclink('link-180', 'Slave', 'link-180');">Slave</a></tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
<a name="L730"></a><tt class="py-lineno">730</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">[</tt><tt class="py-name">slave_id</tt><tt class="py-op">]</tt> </tt>
<a name="L731"></a><tt class="py-lineno">731</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L732"></a><tt class="py-lineno">732</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-181" class="py-name"><a title="modbus_tk.modbus.DuplicatedKeyError" class="py-name" href="#" onclick="return doclink('link-181', 'DuplicatedKeyError', 'link-167');">DuplicatedKeyError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Slave %d already exists"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L733"></a><tt class="py-lineno">733</tt>  <tt class="py-line">         </tt>
<a name="Databank.get_slave"></a><div id="Databank.get_slave-def"><a name="L734"></a><tt class="py-lineno">734</tt> <a class="py-toggle" href="#" id="Databank.get_slave-toggle" onclick="return toggle('Databank.get_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#get_slave">get_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.get_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.get_slave-expanded"><a name="L735"></a><tt class="py-lineno">735</tt>  <tt class="py-line">        <tt class="py-docstring">"""Get the slave with the given id"""</tt> </tt>
<a name="L736"></a><tt class="py-lineno">736</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-182" class="py-name"><a title="modbus_tk.hooks._lock" class="py-name" href="#" onclick="return doclink('link-182', '_lock', 'link-178');">_lock</a></tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L737"></a><tt class="py-lineno">737</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L738"></a><tt class="py-lineno">738</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">[</tt><tt class="py-name">slave_id</tt><tt class="py-op">]</tt> </tt>
<a name="L739"></a><tt class="py-lineno">739</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L740"></a><tt class="py-lineno">740</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-183" class="py-name"><a title="modbus_tk.modbus.MissingKeyError" class="py-name" href="#" onclick="return doclink('link-183', 'MissingKeyError', 'link-173');">MissingKeyError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Slave %d doesn't exist"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L741"></a><tt class="py-lineno">741</tt>  <tt class="py-line">     </tt>
<a name="Databank.remove_slave"></a><div id="Databank.remove_slave-def"><a name="L742"></a><tt class="py-lineno">742</tt> <a class="py-toggle" href="#" id="Databank.remove_slave-toggle" onclick="return toggle('Databank.remove_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#remove_slave">remove_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.remove_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.remove_slave-expanded"><a name="L743"></a><tt class="py-lineno">743</tt>  <tt class="py-line">        <tt class="py-docstring">"""Remove the slave with the given id"""</tt> </tt>
<a name="L744"></a><tt class="py-lineno">744</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-184" class="py-name"><a title="modbus_tk.hooks._lock" class="py-name" href="#" onclick="return doclink('link-184', '_lock', 'link-178');">_lock</a></tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L745"></a><tt class="py-lineno">745</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L746"></a><tt class="py-lineno">746</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
<a name="L747"></a><tt class="py-lineno">747</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L748"></a><tt class="py-lineno">748</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-185" class="py-name"><a title="modbus_tk.modbus.MissingKeyError" class="py-name" href="#" onclick="return doclink('link-185', 'MissingKeyError', 'link-173');">MissingKeyError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Slave %d already exists"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt>     </tt>
</div><a name="L749"></a><tt class="py-lineno">749</tt>  <tt class="py-line">             </tt>
<a name="Databank.remove_all_slaves"></a><div id="Databank.remove_all_slaves-def"><a name="L750"></a><tt class="py-lineno">750</tt> <a class="py-toggle" href="#" id="Databank.remove_all_slaves-toggle" onclick="return toggle('Databank.remove_all_slaves');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#remove_all_slaves">remove_all_slaves</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.remove_all_slaves-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.remove_all_slaves-expanded"><a name="L751"></a><tt class="py-lineno">751</tt>  <tt class="py-line">        <tt class="py-docstring">"""clean the list of slaves"""</tt> </tt>
<a name="L752"></a><tt class="py-lineno">752</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-186" class="py-name"><a title="modbus_tk.hooks._lock" class="py-name" href="#" onclick="return doclink('link-186', '_lock', 'link-178');">_lock</a></tt><tt class="py-op">:</tt> <tt class="py-comment">#thread-safe</tt> </tt>
<a name="L753"></a><tt class="py-lineno">753</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">.</tt><tt class="py-name">clear</tt><tt class="py-op">(</tt><tt class="py-op">)</tt>     </tt>
</div><a name="L754"></a><tt class="py-lineno">754</tt>  <tt class="py-line"> </tt>
<a name="Databank.handle_request"></a><div id="Databank.handle_request-def"><a name="L755"></a><tt class="py-lineno">755</tt> <a class="py-toggle" href="#" id="Databank.handle_request-toggle" onclick="return toggle('Databank.handle_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Databank-class.html#handle_request">handle_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">query</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Databank.handle_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Databank.handle_request-expanded"><a name="L756"></a><tt class="py-lineno">756</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L757"></a><tt class="py-lineno">757</tt>  <tt class="py-line"><tt class="py-docstring">        when a request is received, handle it and returns the response pdu</tt> </tt>
<a name="L758"></a><tt class="py-lineno">758</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L759"></a><tt class="py-lineno">759</tt>  <tt class="py-line">        <tt class="py-name">request_pdu</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L760"></a><tt class="py-lineno">760</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L761"></a><tt class="py-lineno">761</tt>  <tt class="py-line">            <tt class="py-comment">#extract the pdu and the slave id</tt> </tt>
<a name="L762"></a><tt class="py-lineno">762</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name" targets="Method modbus_tk.modbus.Query.parse_request()=modbus_tk.modbus.Query-class.html#parse_request,Method modbus_tk.modbus_rtu.RtuQuery.parse_request()=modbus_tk.modbus_rtu.RtuQuery-class.html#parse_request,Method modbus_tk.modbus_tcp.TcpQuery.parse_request()=modbus_tk.modbus_tcp.TcpQuery-class.html#parse_request"><a title="modbus_tk.modbus.Query.parse_request
modbus_tk.modbus_rtu.RtuQuery.parse_request
modbus_tk.modbus_tcp.TcpQuery.parse_request" class="py-name" href="#" onclick="return doclink('link-187', 'parse_request', 'link-187');">parse_request</a></tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L763"></a><tt class="py-lineno">763</tt>  <tt class="py-line">             </tt>
<a name="L764"></a><tt class="py-lineno">764</tt>  <tt class="py-line">            <tt class="py-comment">#get the slave and let him executes the action</tt> </tt>
<a name="L765"></a><tt class="py-lineno">765</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">slave_id</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L766"></a><tt class="py-lineno">766</tt>  <tt class="py-line">                <tt class="py-comment">#broadcast</tt> </tt>
<a name="L767"></a><tt class="py-lineno">767</tt>  <tt class="py-line">                <tt class="py-keyword">for</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">:</tt> </tt>
<a name="L768"></a><tt class="py-lineno">768</tt>  <tt class="py-line">                    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_slaves</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-188" class="py-name" targets="Method modbus_tk.modbus.Databank.handle_request()=modbus_tk.modbus.Databank-class.html#handle_request,Method modbus_tk.modbus.Slave.handle_request()=modbus_tk.modbus.Slave-class.html#handle_request"><a title="modbus_tk.modbus.Databank.handle_request
modbus_tk.modbus.Slave.handle_request" class="py-name" href="#" onclick="return doclink('link-188', 'handle_request', 'link-188');">handle_request</a></tt><tt class="py-op">(</tt><tt class="py-name">request_pdu</tt><tt class="py-op">,</tt> <tt class="py-name">broadcast</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L769"></a><tt class="py-lineno">769</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> </tt>
<a name="L770"></a><tt class="py-lineno">770</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L771"></a><tt class="py-lineno">771</tt>  <tt class="py-line">                <tt class="py-name">slave</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name" targets="Method modbus_tk.modbus.Databank.get_slave()=modbus_tk.modbus.Databank-class.html#get_slave,Method modbus_tk.modbus.Server.get_slave()=modbus_tk.modbus.Server-class.html#get_slave"><a title="modbus_tk.modbus.Databank.get_slave
modbus_tk.modbus.Server.get_slave" class="py-name" href="#" onclick="return doclink('link-189', 'get_slave', 'link-189');">get_slave</a></tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
<a name="L772"></a><tt class="py-lineno">772</tt>  <tt class="py-line">                <tt class="py-name">response_pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">slave</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name"><a title="modbus_tk.modbus.Databank.handle_request
modbus_tk.modbus.Slave.handle_request" class="py-name" href="#" onclick="return doclink('link-190', 'handle_request', 'link-188');">handle_request</a></tt><tt class="py-op">(</tt><tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> </tt>
<a name="L773"></a><tt class="py-lineno">773</tt>  <tt class="py-line">                <tt class="py-comment">#make the full response</tt> </tt>
<a name="L774"></a><tt class="py-lineno">774</tt>  <tt class="py-line">                <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt id="link-191" class="py-name" targets="Method modbus_tk.modbus.Query.build_response()=modbus_tk.modbus.Query-class.html#build_response,Method modbus_tk.modbus_rtu.RtuQuery.build_response()=modbus_tk.modbus_rtu.RtuQuery-class.html#build_response,Method modbus_tk.modbus_tcp.TcpQuery.build_response()=modbus_tk.modbus_tcp.TcpQuery-class.html#build_response"><a title="modbus_tk.modbus.Query.build_response
modbus_tk.modbus_rtu.RtuQuery.build_response
modbus_tk.modbus_tcp.TcpQuery.build_response" class="py-name" href="#" onclick="return doclink('link-191', 'build_response', 'link-191');">build_response</a></tt><tt class="py-op">(</tt><tt class="py-name">response_pdu</tt><tt class="py-op">)</tt> </tt>
<a name="L775"></a><tt class="py-lineno">775</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
<a name="L776"></a><tt class="py-lineno">776</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">:</tt> </tt>
<a name="L777"></a><tt class="py-lineno">777</tt>  <tt class="py-line">            <tt id="link-192" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-192', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Databank.on_error"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L778"></a><tt class="py-lineno">778</tt>  <tt class="py-line">            <tt id="link-193" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-193', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"handle request failed: "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">excpt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L779"></a><tt class="py-lineno">779</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L780"></a><tt class="py-lineno">780</tt>  <tt class="py-line">            <tt id="link-194" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-194', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"handle request failed: unknown error"</tt><tt class="py-op">)</tt> </tt>
<a name="L781"></a><tt class="py-lineno">781</tt>  <tt class="py-line"> </tt>
<a name="L782"></a><tt class="py-lineno">782</tt>  <tt class="py-line">        <tt class="py-comment">#If the request was not handled correctly, return a server error response</tt> </tt>
<a name="L783"></a><tt class="py-lineno">783</tt>  <tt class="py-line">        <tt class="py-name">func_code</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L784"></a><tt class="py-lineno">784</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">request_pdu</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L785"></a><tt class="py-lineno">785</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">func_code</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-195', 'unpack', 'link-53');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;B"</tt><tt class="py-op">,</tt> <tt class="py-name">request_pdu</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L786"></a><tt class="py-lineno">786</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-196" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-196', 'pack', 'link-16');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;BB"</tt><tt class="py-op">,</tt> <tt class="py-name">func_code</tt><tt class="py-op">+</tt><tt class="py-number">0x80</tt><tt class="py-op">,</tt> <tt id="link-197" class="py-name"><a title="modbus_tk.defines" class="py-name" href="#" onclick="return doclink('link-197', 'defines', 'link-0');">defines</a></tt><tt class="py-op">.</tt><tt id="link-198" class="py-name" targets="Variable modbus_tk.defines.SLAVE_DEVICE_FAILURE=modbus_tk.defines-module.html#SLAVE_DEVICE_FAILURE"><a title="modbus_tk.defines.SLAVE_DEVICE_FAILURE" class="py-name" href="#" onclick="return doclink('link-198', 'SLAVE_DEVICE_FAILURE', 'link-198');">SLAVE_DEVICE_FAILURE</a></tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L787"></a><tt class="py-lineno">787</tt>  <tt class="py-line">     </tt>
<a name="Server"></a><div id="Server-def"><a name="L788"></a><tt class="py-lineno">788</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L789"></a><tt class="py-lineno">789</tt> <a class="py-toggle" href="#" id="Server-toggle" onclick="return toggle('Server');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html">Server</a><tt class="py-op">:</tt> </tt>
</div><div id="Server-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Server-expanded"><a name="L790"></a><tt class="py-lineno">790</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L791"></a><tt class="py-lineno">791</tt>  <tt class="py-line"><tt class="py-docstring">    This class owns several slaves and defines an interface</tt> </tt>
<a name="L792"></a><tt class="py-lineno">792</tt>  <tt class="py-line"><tt class="py-docstring">    to be implemented for a TCP or RTU server</tt> </tt>
<a name="L793"></a><tt class="py-lineno">793</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L794"></a><tt class="py-lineno">794</tt>  <tt class="py-line">     </tt>
<a name="Server.__init__"></a><div id="Server.__init__-def"><a name="L795"></a><tt class="py-lineno">795</tt> <a class="py-toggle" href="#" id="Server.__init__-toggle" onclick="return toggle('Server.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">databank</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.__init__-expanded"><a name="L796"></a><tt class="py-lineno">796</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor"""</tt> </tt>
<a name="L797"></a><tt class="py-lineno">797</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt> <tt class="py-op">=</tt> <tt class="py-name">databank</tt> <tt class="py-keyword">if</tt> <tt class="py-name">databank</tt> <tt class="py-keyword">else</tt> <tt id="link-199" class="py-name" targets="Class modbus_tk.modbus.Databank=modbus_tk.modbus.Databank-class.html"><a title="modbus_tk.modbus.Databank" class="py-name" href="#" onclick="return doclink('link-199', 'Databank', 'link-199');">Databank</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment">#never use a mutable type as default argument</tt> </tt>
<a name="L798"></a><tt class="py-lineno">798</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L799"></a><tt class="py-lineno">799</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L800"></a><tt class="py-lineno">800</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_go</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L801"></a><tt class="py-lineno">801</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-200" class="py-name" targets="Method modbus_tk.modbus.Server._make_thread()=modbus_tk.modbus.Server-class.html#_make_thread,Method modbus_tk.simulator.CompositeServer._make_thread()=modbus_tk.simulator.CompositeServer-class.html#_make_thread"><a title="modbus_tk.modbus.Server._make_thread
modbus_tk.simulator.CompositeServer._make_thread" class="py-name" href="#" onclick="return doclink('link-200', '_make_thread', 'link-200');">_make_thread</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L802"></a><tt class="py-lineno">802</tt>  <tt class="py-line">         </tt>
<a name="Server._do_init"></a><div id="Server._do_init-def"><a name="L803"></a><tt class="py-lineno">803</tt> <a class="py-toggle" href="#" id="Server._do_init-toggle" onclick="return toggle('Server._do_init');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_do_init">_do_init</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._do_init-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._do_init-expanded"><a name="L804"></a><tt class="py-lineno">804</tt>  <tt class="py-line">        <tt class="py-docstring">"""executed before the server starts: to be overridden"""</tt> </tt>
<a name="L805"></a><tt class="py-lineno">805</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L806"></a><tt class="py-lineno">806</tt>  <tt class="py-line">         </tt>
<a name="Server._do_exit"></a><div id="Server._do_exit-def"><a name="L807"></a><tt class="py-lineno">807</tt> <a class="py-toggle" href="#" id="Server._do_exit-toggle" onclick="return toggle('Server._do_exit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_do_exit">_do_exit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._do_exit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._do_exit-expanded"><a name="L808"></a><tt class="py-lineno">808</tt>  <tt class="py-line">        <tt class="py-docstring">"""executed after the server stops: to be overridden"""</tt> </tt>
<a name="L809"></a><tt class="py-lineno">809</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L810"></a><tt class="py-lineno">810</tt>  <tt class="py-line">         </tt>
<a name="Server._do_run"></a><div id="Server._do_run-def"><a name="L811"></a><tt class="py-lineno">811</tt> <a class="py-toggle" href="#" id="Server._do_run-toggle" onclick="return toggle('Server._do_run');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_do_run">_do_run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._do_run-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._do_run-expanded"><a name="L812"></a><tt class="py-lineno">812</tt>  <tt class="py-line">        <tt class="py-docstring">"""main function of the server: to be overridden"""</tt> </tt>
<a name="L813"></a><tt class="py-lineno">813</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L814"></a><tt class="py-lineno">814</tt>  <tt class="py-line"> </tt>
<a name="Server._make_thread"></a><div id="Server._make_thread-def"><a name="L815"></a><tt class="py-lineno">815</tt> <a class="py-toggle" href="#" id="Server._make_thread-toggle" onclick="return toggle('Server._make_thread');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_make_thread">_make_thread</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._make_thread-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._make_thread-expanded"><a name="L816"></a><tt class="py-lineno">816</tt>  <tt class="py-line">        <tt class="py-docstring">"""create the main thread of the server"""</tt> </tt>
<a name="L817"></a><tt class="py-lineno">817</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Thread</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">=</tt><tt id="link-201" class="py-name" targets="Class modbus_tk.modbus.Server=modbus_tk.modbus.Server-class.html"><a title="modbus_tk.modbus.Server" class="py-name" href="#" onclick="return doclink('link-201', 'Server', 'link-201');">Server</a></tt><tt class="py-op">.</tt><tt id="link-202" class="py-name" targets="Method modbus_tk.modbus.Server._run_server()=modbus_tk.modbus.Server-class.html#_run_server"><a title="modbus_tk.modbus.Server._run_server" class="py-name" href="#" onclick="return doclink('link-202', '_run_server', 'link-202');">_run_server</a></tt><tt class="py-op">,</tt> <tt class="py-name">args</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L818"></a><tt class="py-lineno">818</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_go</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Event</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L819"></a><tt class="py-lineno">819</tt>  <tt class="py-line">                 </tt>
<a name="Server.set_verbose"></a><div id="Server.set_verbose-def"><a name="L820"></a><tt class="py-lineno">820</tt> <a class="py-toggle" href="#" id="Server.set_verbose-toggle" onclick="return toggle('Server.set_verbose');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#set_verbose">set_verbose</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">verbose</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.set_verbose-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.set_verbose-expanded"><a name="L821"></a><tt class="py-lineno">821</tt>  <tt class="py-line">        <tt class="py-docstring">"""if verbose is true the sent and received packets will be logged"""</tt> </tt>
<a name="L822"></a><tt class="py-lineno">822</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt> <tt class="py-op">=</tt> <tt class="py-name">verbose</tt> </tt>
</div><a name="L823"></a><tt class="py-lineno">823</tt>  <tt class="py-line"> </tt>
<a name="Server.get_db"></a><div id="Server.get_db-def"><a name="L824"></a><tt class="py-lineno">824</tt> <a class="py-toggle" href="#" id="Server.get_db-toggle" onclick="return toggle('Server.get_db');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#get_db">get_db</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.get_db-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.get_db-expanded"><a name="L825"></a><tt class="py-lineno">825</tt>  <tt class="py-line">        <tt class="py-docstring">"""returns the databank"""</tt> </tt>
<a name="L826"></a><tt class="py-lineno">826</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt> </tt>
</div><a name="L827"></a><tt class="py-lineno">827</tt>  <tt class="py-line"> </tt>
<a name="Server.add_slave"></a><div id="Server.add_slave-def"><a name="L828"></a><tt class="py-lineno">828</tt> <a class="py-toggle" href="#" id="Server.add_slave-toggle" onclick="return toggle('Server.add_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#add_slave">add_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.add_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.add_slave-expanded"><a name="L829"></a><tt class="py-lineno">829</tt>  <tt class="py-line">        <tt class="py-docstring">"""add slave to the server"""</tt> </tt>
<a name="L830"></a><tt class="py-lineno">830</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt><tt class="py-op">.</tt><tt id="link-203" class="py-name" targets="Method modbus_tk.modbus.Databank.add_slave()=modbus_tk.modbus.Databank-class.html#add_slave,Method modbus_tk.modbus.Server.add_slave()=modbus_tk.modbus.Server-class.html#add_slave,Method modbus_tk.simulator_rpc_client.SimulatorRpcClient.add_slave()=modbus_tk.simulator_rpc_client.SimulatorRpcClient-class.html#add_slave"><a title="modbus_tk.modbus.Databank.add_slave
modbus_tk.modbus.Server.add_slave
modbus_tk.simulator_rpc_client.SimulatorRpcClient.add_slave" class="py-name" href="#" onclick="return doclink('link-203', 'add_slave', 'link-203');">add_slave</a></tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L831"></a><tt class="py-lineno">831</tt>  <tt class="py-line">         </tt>
<a name="Server.get_slave"></a><div id="Server.get_slave-def"><a name="L832"></a><tt class="py-lineno">832</tt> <a class="py-toggle" href="#" id="Server.get_slave-toggle" onclick="return toggle('Server.get_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#get_slave">get_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.get_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.get_slave-expanded"><a name="L833"></a><tt class="py-lineno">833</tt>  <tt class="py-line">        <tt class="py-docstring">"""get the slave with the given id"""</tt> </tt>
<a name="L834"></a><tt class="py-lineno">834</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="modbus_tk.modbus.Databank.get_slave
modbus_tk.modbus.Server.get_slave" class="py-name" href="#" onclick="return doclink('link-204', 'get_slave', 'link-189');">get_slave</a></tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L835"></a><tt class="py-lineno">835</tt>  <tt class="py-line">     </tt>
<a name="Server.remove_slave"></a><div id="Server.remove_slave-def"><a name="L836"></a><tt class="py-lineno">836</tt> <a class="py-toggle" href="#" id="Server.remove_slave-toggle" onclick="return toggle('Server.remove_slave');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#remove_slave">remove_slave</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">slave_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.remove_slave-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.remove_slave-expanded"><a name="L837"></a><tt class="py-lineno">837</tt>  <tt class="py-line">        <tt class="py-docstring">"""remove the slave with the given id"""</tt> </tt>
<a name="L838"></a><tt class="py-lineno">838</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt><tt class="py-op">.</tt><tt id="link-205" class="py-name" targets="Method modbus_tk.modbus.Databank.remove_slave()=modbus_tk.modbus.Databank-class.html#remove_slave,Method modbus_tk.modbus.Server.remove_slave()=modbus_tk.modbus.Server-class.html#remove_slave,Method modbus_tk.simulator_rpc_client.SimulatorRpcClient.remove_slave()=modbus_tk.simulator_rpc_client.SimulatorRpcClient-class.html#remove_slave"><a title="modbus_tk.modbus.Databank.remove_slave
modbus_tk.modbus.Server.remove_slave
modbus_tk.simulator_rpc_client.SimulatorRpcClient.remove_slave" class="py-name" href="#" onclick="return doclink('link-205', 'remove_slave', 'link-205');">remove_slave</a></tt><tt class="py-op">(</tt><tt class="py-name">slave_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L839"></a><tt class="py-lineno">839</tt>  <tt class="py-line">     </tt>
<a name="Server.remove_all_slaves"></a><div id="Server.remove_all_slaves-def"><a name="L840"></a><tt class="py-lineno">840</tt> <a class="py-toggle" href="#" id="Server.remove_all_slaves-toggle" onclick="return toggle('Server.remove_all_slaves');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#remove_all_slaves">remove_all_slaves</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.remove_all_slaves-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.remove_all_slaves-expanded"><a name="L841"></a><tt class="py-lineno">841</tt>  <tt class="py-line">        <tt class="py-docstring">"""remove the slave with the given id"""</tt> </tt>
<a name="L842"></a><tt class="py-lineno">842</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name" targets="Method modbus_tk.modbus.Databank.remove_all_slaves()=modbus_tk.modbus.Databank-class.html#remove_all_slaves,Method modbus_tk.modbus.Server.remove_all_slaves()=modbus_tk.modbus.Server-class.html#remove_all_slaves,Method modbus_tk.simulator_rpc_client.SimulatorRpcClient.remove_all_slaves()=modbus_tk.simulator_rpc_client.SimulatorRpcClient-class.html#remove_all_slaves"><a title="modbus_tk.modbus.Databank.remove_all_slaves
modbus_tk.modbus.Server.remove_all_slaves
modbus_tk.simulator_rpc_client.SimulatorRpcClient.remove_all_slaves" class="py-name" href="#" onclick="return doclink('link-206', 'remove_all_slaves', 'link-206');">remove_all_slaves</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L843"></a><tt class="py-lineno">843</tt>  <tt class="py-line">         </tt>
<a name="Server._make_query"></a><div id="Server._make_query-def"><a name="L844"></a><tt class="py-lineno">844</tt> <a class="py-toggle" href="#" id="Server._make_query-toggle" onclick="return toggle('Server._make_query');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_make_query">_make_query</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._make_query-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._make_query-expanded"><a name="L845"></a><tt class="py-lineno">845</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L846"></a><tt class="py-lineno">846</tt>  <tt class="py-line"><tt class="py-docstring">        Returns an instance of a Query subclass implementing </tt> </tt>
<a name="L847"></a><tt class="py-lineno">847</tt>  <tt class="py-line"><tt class="py-docstring">        the MAC layer protocol</tt> </tt>
<a name="L848"></a><tt class="py-lineno">848</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L849"></a><tt class="py-lineno">849</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L850"></a><tt class="py-lineno">850</tt>  <tt class="py-line">     </tt>
<a name="Server.start"></a><div id="Server.start-def"><a name="L851"></a><tt class="py-lineno">851</tt> <a class="py-toggle" href="#" id="Server.start-toggle" onclick="return toggle('Server.start');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#start">start</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.start-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.start-expanded"><a name="L852"></a><tt class="py-lineno">852</tt>  <tt class="py-line">        <tt class="py-docstring">"""Start the server. It will handle request"""</tt> </tt>
<a name="L853"></a><tt class="py-lineno">853</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_go</tt><tt class="py-op">.</tt><tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L854"></a><tt class="py-lineno">854</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread</tt><tt class="py-op">.</tt><tt id="link-207" class="py-name" targets="Method modbus_tk.modbus.Server.start()=modbus_tk.modbus.Server-class.html#start,Method modbus_tk.simulator.CompositeServer.start()=modbus_tk.simulator.CompositeServer-class.html#start,Method modbus_tk.simulator.Simulator.start()=modbus_tk.simulator.Simulator-class.html#start,Method modbus_tk.utils.WorkerThread.start()=modbus_tk.utils.WorkerThread-class.html#start"><a title="modbus_tk.modbus.Server.start
modbus_tk.simulator.CompositeServer.start
modbus_tk.simulator.Simulator.start
modbus_tk.utils.WorkerThread.start" class="py-name" href="#" onclick="return doclink('link-207', 'start', 'link-207');">start</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L855"></a><tt class="py-lineno">855</tt>  <tt class="py-line">     </tt>
<a name="Server.stop"></a><div id="Server.stop-def"><a name="L856"></a><tt class="py-lineno">856</tt> <a class="py-toggle" href="#" id="Server.stop-toggle" onclick="return toggle('Server.stop');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#stop">stop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server.stop-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server.stop-expanded"><a name="L857"></a><tt class="py-lineno">857</tt>  <tt class="py-line">        <tt class="py-docstring">"""stop the server. It doesn't handle request anymore"""</tt> </tt>
<a name="L858"></a><tt class="py-lineno">858</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread</tt><tt class="py-op">.</tt><tt class="py-name">isAlive</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L859"></a><tt class="py-lineno">859</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_go</tt><tt class="py-op">.</tt><tt class="py-name">clear</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L860"></a><tt class="py-lineno">860</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L861"></a><tt class="py-lineno">861</tt>  <tt class="py-line">             </tt>
<a name="Server._run_server"></a><div id="Server._run_server-def"><a name="L862"></a><tt class="py-lineno">862</tt> <a class="py-toggle" href="#" id="Server._run_server-toggle" onclick="return toggle('Server._run_server');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_run_server">_run_server</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._run_server-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._run_server-expanded"><a name="L863"></a><tt class="py-lineno">863</tt>  <tt class="py-line">        <tt class="py-docstring">"""main function of the main thread"""</tt> </tt>
<a name="L864"></a><tt class="py-lineno">864</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L865"></a><tt class="py-lineno">865</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name" targets="Method modbus_tk.modbus.Server._do_init()=modbus_tk.modbus.Server-class.html#_do_init,Method modbus_tk.modbus_rtu.RtuServer._do_init()=modbus_tk.modbus_rtu.RtuServer-class.html#_do_init,Method modbus_tk.modbus_tcp.TcpServer._do_init()=modbus_tk.modbus_tcp.TcpServer-class.html#_do_init"><a title="modbus_tk.modbus.Server._do_init
modbus_tk.modbus_rtu.RtuServer._do_init
modbus_tk.modbus_tcp.TcpServer._do_init" class="py-name" href="#" onclick="return doclink('link-208', '_do_init', 'link-208');">_do_init</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L866"></a><tt class="py-lineno">866</tt>  <tt class="py-line">            <tt class="py-keyword">while</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_go</tt><tt class="py-op">.</tt><tt class="py-name">isSet</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L867"></a><tt class="py-lineno">867</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name" targets="Method modbus_tk.modbus.Server._do_run()=modbus_tk.modbus.Server-class.html#_do_run,Method modbus_tk.modbus_rtu.RtuServer._do_run()=modbus_tk.modbus_rtu.RtuServer-class.html#_do_run,Method modbus_tk.modbus_tcp.TcpServer._do_run()=modbus_tk.modbus_tcp.TcpServer-class.html#_do_run"><a title="modbus_tk.modbus.Server._do_run
modbus_tk.modbus_rtu.RtuServer._do_run
modbus_tk.modbus_tcp.TcpServer._do_run" class="py-name" href="#" onclick="return doclink('link-209', '_do_run', 'link-209');">_do_run</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L868"></a><tt class="py-lineno">868</tt>  <tt class="py-line">            <tt id="link-210" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-210', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"%s has stopped"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt> </tt>
<a name="L869"></a><tt class="py-lineno">869</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name" targets="Method modbus_tk.modbus.Server._do_exit()=modbus_tk.modbus.Server-class.html#_do_exit,Method modbus_tk.modbus_rtu.RtuServer._do_exit()=modbus_tk.modbus_rtu.RtuServer-class.html#_do_exit,Method modbus_tk.modbus_tcp.TcpServer._do_exit()=modbus_tk.modbus_tcp.TcpServer-class.html#_do_exit"><a title="modbus_tk.modbus.Server._do_exit
modbus_tk.modbus_rtu.RtuServer._do_exit
modbus_tk.modbus_tcp.TcpServer._do_exit" class="py-name" href="#" onclick="return doclink('link-211', '_do_exit', 'link-211');">_do_exit</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L870"></a><tt class="py-lineno">870</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">:</tt> </tt>
<a name="L871"></a><tt class="py-lineno">871</tt>  <tt class="py-line">            <tt id="link-212" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-212', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"server error: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">excpt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L872"></a><tt class="py-lineno">872</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="modbus_tk.modbus.Server._make_thread
modbus_tk.simulator.CompositeServer._make_thread" class="py-name" href="#" onclick="return doclink('link-213', '_make_thread', 'link-200');">_make_thread</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment">#make possible to rerun in future</tt> </tt>
</div><a name="L873"></a><tt class="py-lineno">873</tt>  <tt class="py-line"> </tt>
<a name="Server._handle"></a><div id="Server._handle-def"><a name="L874"></a><tt class="py-lineno">874</tt> <a class="py-toggle" href="#" id="Server._handle-toggle" onclick="return toggle('Server._handle');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus.Server-class.html#_handle">_handle</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Server._handle-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Server._handle-expanded"><a name="L875"></a><tt class="py-lineno">875</tt>  <tt class="py-line">        <tt class="py-docstring">"""handle a received sentence"""</tt> </tt>
<a name="L876"></a><tt class="py-lineno">876</tt>  <tt class="py-line">         </tt>
<a name="L877"></a><tt class="py-lineno">877</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L878"></a><tt class="py-lineno">878</tt>  <tt class="py-line">            <tt id="link-214" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-214', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt id="link-215" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-215', 'utils', 'link-1');">utils</a></tt><tt class="py-op">.</tt><tt id="link-216" class="py-name"><a title="modbus_tk.utils.get_log_buffer" class="py-name" href="#" onclick="return doclink('link-216', 'get_log_buffer', 'link-44');">get_log_buffer</a></tt><tt class="py-op">(</tt><tt class="py-string">"--&gt;"</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L879"></a><tt class="py-lineno">879</tt>  <tt class="py-line">         </tt>
<a name="L880"></a><tt class="py-lineno">880</tt>  <tt class="py-line">        <tt class="py-comment">#gets a query for analyzing the request</tt> </tt>
<a name="L881"></a><tt class="py-lineno">881</tt>  <tt class="py-line">        <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="modbus_tk.modbus.Master._make_query
modbus_tk.modbus.Server._make_query
modbus_tk.modbus_rtu.RtuMaster._make_query
modbus_tk.modbus_rtu.RtuServer._make_query
modbus_tk.modbus_tcp.TcpMaster._make_query
modbus_tk.modbus_tcp.TcpServer._make_query
modbus_tk.simulator.CompositeServer._make_query" class="py-name" href="#" onclick="return doclink('link-217', '_make_query', 'link-39');">_make_query</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L882"></a><tt class="py-lineno">882</tt>  <tt class="py-line">         </tt>
<a name="L883"></a><tt class="py-lineno">883</tt>  <tt class="py-line">        <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-218" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-218', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Server.before_handle_request"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L884"></a><tt class="py-lineno">884</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno">885</tt>  <tt class="py-line">            <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L886"></a><tt class="py-lineno">886</tt>  <tt class="py-line">             </tt>
<a name="L887"></a><tt class="py-lineno">887</tt>  <tt class="py-line">        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_databank</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="modbus_tk.modbus.Databank.handle_request
modbus_tk.modbus.Slave.handle_request" class="py-name" href="#" onclick="return doclink('link-219', 'handle_request', 'link-188');">handle_request</a></tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L888"></a><tt class="py-lineno">888</tt>  <tt class="py-line">        <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-220" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-220', 'call_hooks', 'link-5');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus.Server.after_handle_request"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L889"></a><tt class="py-lineno">889</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt><tt class="py-op">:</tt> </tt>
<a name="L890"></a><tt class="py-lineno">890</tt>  <tt class="py-line">            <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L891"></a><tt class="py-lineno">891</tt>  <tt class="py-line">                 </tt>
<a name="L892"></a><tt class="py-lineno">892</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">response</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L893"></a><tt class="py-lineno">893</tt>  <tt class="py-line">            <tt id="link-221" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-221', 'LOGGER', 'link-6');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt id="link-222" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-222', 'utils', 'link-1');">utils</a></tt><tt class="py-op">.</tt><tt id="link-223" class="py-name"><a title="modbus_tk.utils.get_log_buffer" class="py-name" href="#" onclick="return doclink('link-223', 'get_log_buffer', 'link-44');">get_log_buffer</a></tt><tt class="py-op">(</tt><tt class="py-string">"&lt;--"</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L894"></a><tt class="py-lineno">894</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
</div></div><a name="L895"></a><tt class="py-lineno">895</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/modbus-tk/">Modbus Test Kit</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed May 26 17:43:08 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
